OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

docbook message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Marking up optional parameters?


Hi DocBook users

I'm marking up some reference pages for perl modules. I'm describing each 
method of the module using <funcsynopsis>, and then each parameter of 
each method using <paramdef>. Is there a recognised way of noting that 
some parameters are optional (in perl, you don't have function prototypes as 
such, so the typical get/set method is a get method when you don't give it 
an argument, and a set method when you do)?

Peter



[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]