← Prev in month ← Prev in thread

Function prototype comments

From
Russell Shaw <>
Date
2005-10-16T01:47:46+00:00
ID
Thread
Function prototype comments
Hi,
Where do i put parameter comments (/*...*/) in function prototypes?
When i try it, the semicolons come after the comments instead of after
the parameters:

XkbDoodadPtr XkbAddGeomDoodad(geom,
                               section,
                               name);

XkbGeometryPtr geom /* geometry to which the doodad is added */;
XkbSectionPtr  section /* section, if any, to which the doodad is added */;
Atom           name /* name of the new doodad */;


I'm using Docbook refentry DTD 4.2.

<funcprototype>
   <funcdef>
     XkbDoodadPtr
     <function>
       XkbAddGeomDoodad
     </function>
   </funcdef>

   <paramdef>
     XkbGeometryPtr
     <parameter>
       geom
     </parameter>/* geometry to which the doodad is added */
   </paramdef>

   <paramdef>
     XkbSectionPtr
     <parameter>
       section
     </parameter>/* section, if any, to which the doodad is added */
   </paramdef>

   <paramdef>
     Atom
     <parameter>
       name
     </parameter>/* name of the new doodad */
   </paramdef>
</funcprototype>
← Prev in month ← Prev in thread