<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD>
<META http-equiv=Content-Type content="text/html; charset=us-ascii">
<META content="MSHTML 6.00.2900.3314" name=GENERATOR></HEAD>
<BODY>
<DIV><FONT face=Arial size=2></FONT> </DIV>
<DIV><SPAN class=968563517-26062008><FONT face=Arial size=2>I am working on
generating some documentation for the Upstart and for the contents of the job
file I would like to use the comments within the code to generate
documentation.</FONT></SPAN></DIV>
<DIV><SPAN class=968563517-26062008><FONT face=Arial
size=2></FONT></SPAN> </DIV>
<DIV><SPAN class=968563517-26062008><FONT face=Arial size=2>I notice the
following style for comments.</FONT></SPAN></DIV>
<DIV><SPAN class=968563517-26062008><FONT face=Arial
size=2></FONT></SPAN> </DIV>
<DIV><SPAN class=968563517-26062008><FONT face=Arial size=2>/**<BR> *
stanza_chdir:<BR> * @class: job class being parsed,<BR> * @stanza:
stanza found,<BR> * @file: file or string to parse,<BR> * @len: length
of @file,<BR> * @pos: offset within @file,<BR> * @lineno: line
number.<BR> *<BR> * Parse a chdir stanza from @file, extracting a
single argument<BR> * containing a directory name.<BR> *<BR> *
Returns: zero on success, negative value on error.<BR> **/<BR>Does this
style conform to some document generation tool/format? </FONT></SPAN></DIV>
<DIV><SPAN class=968563517-26062008><FONT face=Arial size=2>If it already
does not, and a choice for this has not been made would Doxygen work
for the rest of the team.</FONT></SPAN></DIV>
<DIV><SPAN class=968563517-26062008><FONT face=Arial
size=2></FONT></SPAN> </DIV>
<DIV><SPAN class=968563517-26062008><FONT face=Arial size=2>I do not plan on
modifying or organizing the comments all around the code. For the most part only
those relting to the public interface.</FONT></SPAN></DIV>
<DIV><SPAN class=968563517-26062008><FONT face=Arial size=2> 1. Upstart
D-Bus Objects</FONT></SPAN></DIV>
<DIV><SPAN class=968563517-26062008><FONT face=Arial size=2> 2.
stanza_* in parse.job.c</FONT></SPAN></DIV>
<DIV><SPAN class=968563517-26062008><FONT face=Arial
size=2></FONT></SPAN> </DIV>
<DIV><SPAN class=968563517-26062008><FONT face=Arial
size=2>Thx,</FONT></SPAN></DIV>
<DIV><SPAN class=968563517-26062008><FONT face=Arial
size=2>Sarvi</FONT></SPAN></DIV></BODY></HTML>