<div dir="ltr">Peter,<br><br><div class="gmail_quote">On Wed, Sep 24, 2008 at 5:02 AM, Peter von Kaehne <span dir="ltr">&lt;<a href="mailto:refdoc@gmx.net">refdoc@gmx.net</a>&gt;</span> wrote:<br><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
Do you think there is enough info there to start creating some man pages?</blockquote><div><br>I presume you mean for the command-line tools in the utilities directory?&nbsp; I don&#39;t believe any of those really have Doxy-style comments in them.&nbsp; I do know that Doxygen is able to create man-style pages, but without Doxy comments, it won&#39;t produce any such files.&nbsp; If you mean man-style pages of the class/header references, then that should be as simple as enabling the option to create the man pages in the Doxyfile, which I can do.&nbsp; However, you&#39;d then need to run Doxygen on your own system and install the files yourself, unless we start including the Doxyfile with the SWORD engine and adding a make target to build/install the documentation files.<br>
&nbsp;</div><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;"><br>
<br>
I think the usage examples given with the command line options are a bit sparse and could do with augmenting. I would be part of that.</blockquote><div><br><br>The main step would be figuring out how to properly comment a main function in Doxy-style comments and adding them to the files which lack them (which, I believe, is all of the CLI tools).&nbsp; Once you&#39;ve done that, submit a patch to the list and someone with SVN commit access will add them to the repository.&nbsp; Then we can talk about putting a Doxyfile with the reulgarly distributed engine and adding the necessary steps to the build process.<br>
<br>--Greg<br>&nbsp;</div><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;"><br>
<br>
Peter<br>
-------- Original-Nachricht --------<br>
&gt; Datum: Tue, 23 Sep 2008 18:17:53 -0500<br>
&gt; Von: &quot;Greg Hellings&quot; &lt;<a href="mailto:greg.hellings@gmail.com">greg.hellings@gmail.com</a>&gt;<br>
&gt; An: &quot;SWORD Developers\&#39; Collaboration Forum&quot; &lt;<a href="mailto:sword-devel@crosswire.org">sword-devel@crosswire.org</a>&gt;<br>
&gt; Betreff: [sword-devel] Documentation update<br>
<div><div></div><div class="Wj3C7c"><br>
&gt; List,<br>
&gt; I&#39;ve updated the sword-svn documentation kept in<br>
&gt; <a href="http://www.crosswire.org/%7Eghellings/svnclassdocs/" target="_blank">http://www.crosswire.org/~ghellings/svnclassdocs/</a> to revision 2205 of the<br>
&gt; SVN tree.<br>
&gt;<br>
&gt; I have attached a patch which works out several Doxygen errors/warnings,<br>
&gt; and<br>
&gt; the following ones remain. &nbsp;I did not feel comfortable filling in the<br>
&gt; missing documentation that these indicate, so I leave it to someone who is<br>
&gt; more familiar with those sections of the code. &nbsp;Also, if I may have<br>
&gt; mislabeled the few portions of the code which are in this patch file, so<br>
&gt; please take care in looking at that.<br>
&gt;<br>
&gt; The remaining warnings are as follows:<br>
&gt;<br>
&gt; /space/home/ghellings/sword-svn/include/swmgr.h:209: Warning: The<br>
&gt; following<br>
&gt; parameters of SWMgr::SWMgr(SWConfig *iconfig=0, SWConfig *isysconfig=0,<br>
&gt; bool<br>
&gt; autoload=true, SWFilterMgr *filterMgr=0, bool multiMod=false) are not<br>
&gt; documented:<br>
&gt; &nbsp; parameter &#39;multiMod&#39;<br>
&gt; /space/home/ghellings/sword-svn/include/swmgr.h:230: Warning: The<br>
&gt; following<br>
&gt; parameters of SWMgr::SWMgr(const char *iConfigPath, bool autoload=true,<br>
&gt; SWFilterMgr *filterMgr=0, bool multiMod=false, bool augmentHome=true) are<br>
&gt; not documented:<br>
&gt; &nbsp; parameter &#39;autoload&#39;<br>
&gt; &nbsp; parameter &#39;filterMgr&#39;<br>
&gt; &nbsp; parameter &#39;multiMod&#39;<br>
&gt; &nbsp; parameter &#39;augmentHome&#39;<br>
&gt;<br>
&gt; ****Greg&#39;s note: these might represent different naming schemes between<br>
&gt; the<br>
&gt; header and the implementation file - but I&#39;m not certain about that****<br>
&gt; /space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:216: Warning:<br>
&gt; argument<br>
&gt; &#39;text&#39; of command @param is not found in the argument list of<br>
&gt; StringMgr::upperLatin1(char *buf, unsigned int maxlen=0) const<br>
&gt; /space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:216: Warning:<br>
&gt; argument<br>
&gt; &#39;max&#39; of command @param is not found in the argument list of<br>
&gt; StringMgr::upperLatin1(char *buf, unsigned int maxlen=0) const<br>
&gt; /space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:216: Warning:<br>
&gt; argument<br>
&gt; &#39;The&#39; of command @param is not found in the argument list of<br>
&gt; StringMgr::upperLatin1(char *buf, unsigned int maxlen=0) const<br>
&gt; /space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:216: Warning: The<br>
&gt; following parameters of StringMgr::upperLatin1(char *buf, unsigned int<br>
&gt; maxlen=0) const are not documented:<br>
&gt; &nbsp; parameter &#39;buf&#39;<br>
&gt; &nbsp; parameter &#39;maxlen&#39;<br>
&gt; /space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:180: Warning:<br>
&gt; argument<br>
&gt; &#39;text&#39; of command @param is not found in the argument list of<br>
&gt; StringMgr::upperUTF8(char *t, unsigned int maxlen=0) const<br>
&gt; /space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:180: Warning:<br>
&gt; argument<br>
&gt; &#39;max&#39; of command @param is not found in the argument list of<br>
&gt; StringMgr::upperUTF8(char *t, unsigned int maxlen=0) const<br>
&gt; /space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:180: Warning: The<br>
&gt; following parameters of StringMgr::upperUTF8(char *t, unsigned int<br>
&gt; maxlen=0)<br>
&gt; const are not documented:<br>
&gt; &nbsp; parameter &#39;maxlen&#39;<br>
&gt;<br>
&gt; /space/home/ghellings/sword-svn/include/listkey.h:81: Warning: The<br>
&gt; following<br>
&gt; parameters of ListKey::SetToElement(int ielement, SW_POSITION pos=TOP) are<br>
&gt; not documented:<br>
&gt; &nbsp; parameter &#39;pos&#39;<br>
&gt;<br>
&gt; /space/home/ghellings/sword-svn/src/modules/swmodule.cpp:1248: Warning: no<br>
&gt; matching class member found for<br>
&gt; &nbsp; void SWModule::filterBuffer(std::list&lt; SWOptionFilter * &gt; *filters,<br>
&gt; SWBuf<br>
&gt; &amp;buf, SWKey *key)<br>
&gt; Possible candidates:<br>
&gt; &nbsp; virtual void SWModule::filterBuffer(OptionFilterList *filters, SWBuf<br>
&gt; &amp;buf,<br>
&gt; SWKey *key)<br>
&gt; &nbsp; virtual void SWModule::filterBuffer(FilterList *filters, SWBuf &amp;buf,<br>
&gt; SWKey<br>
&gt; *key)<br>
&gt; /space/home/ghellings/sword-svn/src/modules/swmodule.cpp:1260: Warning: no<br>
&gt; matching class member found for<br>
&gt; &nbsp; void SWModule::filterBuffer(std::list&lt; SWFilter * &gt; *filters, SWBuf<br>
&gt; &amp;buf,<br>
&gt; SWKey *key)<br>
&gt; Possible candidates:<br>
&gt; &nbsp; virtual void SWModule::filterBuffer(OptionFilterList *filters, SWBuf<br>
&gt; &amp;buf,<br>
&gt; SWKey *key)<br>
&gt; &nbsp; virtual void SWModule::filterBuffer(FilterList *filters, SWBuf &amp;buf,<br>
&gt; SWKey<br>
&gt; *key)<br>
&gt; /space/home/ghellings/sword-svn/include/apocrypha.h:212: Warning:<br>
&gt; documented<br>
&gt; function `long VerseKey::atbks&#39; was not declared or defined.<br>
&gt; /space/home/ghellings/sword-svn/include/apocrypha.h:217: Warning:<br>
&gt; documented<br>
&gt; function `long VerseKey::atcps&#39; was not declared or defined.<br>
&gt;<br>
&gt; Once again, feedback on the documentation configuration is appreciated if<br>
&gt; you find something missing or too much present, etc, or if you have<br>
&gt; expertise with Doxygen (because I sure don&#39;t).<br>
&gt;<br>
&gt; --Greg<br>
<br>
</div></div><font color="#888888">--<br>
GMX startet ShortView.de. Hier findest Du Leute mit Deinen Interessen!<br>
Jetzt dabei sein: <a href="http://www.shortview.de/wasistshortview.php?mc=sv_ext_mf@gmx" target="_blank">http://www.shortview.de/wasistshortview.php?mc=sv_ext_mf@gmx</a><br>
<br>
_______________________________________________<br>
sword-devel mailing list: <a href="mailto:sword-devel@crosswire.org">sword-devel@crosswire.org</a><br>
<a href="http://www.crosswire.org/mailman/listinfo/sword-devel" target="_blank">http://www.crosswire.org/mailman/listinfo/sword-devel</a><br>
Instructions to unsubscribe/change your settings at above page<br>
</font></blockquote></div><br></div>