Re: SGML on functions

On 29 August 2010 16:21, Kevin Grittner <Kevin(dot)Grittner(at)wicourts(dot)gov> wrote:
> Alvaro Herrera <alvherre(at)commandprompt(dot)com> wrote:
>> Excerpts from Thom Brown's message:
>
>>> <function>variance</function>(<replaceable
>>> class="parameter">expression</replaceable>)
>>>
>>> vs
>>>
>>> <function>stddev_samp(<replaceable
>>> class="parameter">expression</replaceable>)</function>
>>>
>>> Which way is correct?
>>
>> The latter I think -- see
>> http://www.docbook.org/tdg/en/html/function.html
>> (but perhaps search the actual standard)
>
> Nothing I saw at that link suggests that the parameters should be
> included within the <function> scope.  If you follow links from
> there to here:
>
> http://www.docbook.org/tdg/en/html/funcsynopsis.html
>
> You find examples like this:
>
> <funcsynopsis>
> <funcprototype>
>  <funcdef>void <function>qsort</function></funcdef>
>    <paramdef>void *<parameter>dataptr</parameter>[]</paramdef>
>    <paramdef>int <parameter>left</parameter></paramdef>
>    <paramdef>int <parameter>right</parameter></paramdef>
>    <paramdef>int <parameter>(* comp)</parameter>
>      <funcparams>void *, void *</funcparams></paramdef>
> </funcprototype>
> </funcsynopsis>
>

But that page also says "Using FuncSynopsis for languages that are
unrelated to C may prove difficult."

Using that syntax will result in a semi-colon being placed at the end
of the function when parsed.

--
Thom Brown
Twitter: @darkixion
IRC (freenode): dark_ixion
Registered Linux user: #516935