<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"><<a href="mailto:refdoc@gmx.net">refdoc@gmx.net</a>></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? I don't believe any of those really have Doxy-style comments in them. I do know that Doxygen is able to create man-style pages, but without Doxy comments, it won't produce any such files. 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. However, you'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>
</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). Once you've done that, submit a patch to the list and someone with SVN commit access will add them to the repository. 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> </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>
> Datum: Tue, 23 Sep 2008 18:17:53 -0500<br>
> Von: "Greg Hellings" <<a href="mailto:greg.hellings@gmail.com">greg.hellings@gmail.com</a>><br>
> An: "SWORD Developers\' Collaboration Forum" <<a href="mailto:sword-devel@crosswire.org">sword-devel@crosswire.org</a>><br>
> Betreff: [sword-devel] Documentation update<br>
<div><div></div><div class="Wj3C7c"><br>
> List,<br>
> I've updated the sword-svn documentation kept in<br>
> <a href="http://www.crosswire.org/%7Eghellings/svnclassdocs/" target="_blank">http://www.crosswire.org/~ghellings/svnclassdocs/</a> to revision 2205 of the<br>
> SVN tree.<br>
><br>
> I have attached a patch which works out several Doxygen errors/warnings,<br>
> and<br>
> the following ones remain. I did not feel comfortable filling in the<br>
> missing documentation that these indicate, so I leave it to someone who is<br>
> more familiar with those sections of the code. Also, if I may have<br>
> mislabeled the few portions of the code which are in this patch file, so<br>
> please take care in looking at that.<br>
><br>
> The remaining warnings are as follows:<br>
><br>
> /space/home/ghellings/sword-svn/include/swmgr.h:209: Warning: The<br>
> following<br>
> parameters of SWMgr::SWMgr(SWConfig *iconfig=0, SWConfig *isysconfig=0,<br>
> bool<br>
> autoload=true, SWFilterMgr *filterMgr=0, bool multiMod=false) are not<br>
> documented:<br>
> parameter 'multiMod'<br>
> /space/home/ghellings/sword-svn/include/swmgr.h:230: Warning: The<br>
> following<br>
> parameters of SWMgr::SWMgr(const char *iConfigPath, bool autoload=true,<br>
> SWFilterMgr *filterMgr=0, bool multiMod=false, bool augmentHome=true) are<br>
> not documented:<br>
> parameter 'autoload'<br>
> parameter 'filterMgr'<br>
> parameter 'multiMod'<br>
> parameter 'augmentHome'<br>
><br>
> ****Greg's note: these might represent different naming schemes between<br>
> the<br>
> header and the implementation file - but I'm not certain about that****<br>
> /space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:216: Warning:<br>
> argument<br>
> 'text' of command @param is not found in the argument list of<br>
> StringMgr::upperLatin1(char *buf, unsigned int maxlen=0) const<br>
> /space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:216: Warning:<br>
> argument<br>
> 'max' of command @param is not found in the argument list of<br>
> StringMgr::upperLatin1(char *buf, unsigned int maxlen=0) const<br>
> /space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:216: Warning:<br>
> argument<br>
> 'The' of command @param is not found in the argument list of<br>
> StringMgr::upperLatin1(char *buf, unsigned int maxlen=0) const<br>
> /space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:216: Warning: The<br>
> following parameters of StringMgr::upperLatin1(char *buf, unsigned int<br>
> maxlen=0) const are not documented:<br>
> parameter 'buf'<br>
> parameter 'maxlen'<br>
> /space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:180: Warning:<br>
> argument<br>
> 'text' of command @param is not found in the argument list of<br>
> StringMgr::upperUTF8(char *t, unsigned int maxlen=0) const<br>
> /space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:180: Warning:<br>
> argument<br>
> 'max' of command @param is not found in the argument list of<br>
> StringMgr::upperUTF8(char *t, unsigned int maxlen=0) const<br>
> /space/home/ghellings/sword-svn/src/mgr/stringmgr.cpp:180: Warning: The<br>
> following parameters of StringMgr::upperUTF8(char *t, unsigned int<br>
> maxlen=0)<br>
> const are not documented:<br>
> parameter 'maxlen'<br>
><br>
> /space/home/ghellings/sword-svn/include/listkey.h:81: Warning: The<br>
> following<br>
> parameters of ListKey::SetToElement(int ielement, SW_POSITION pos=TOP) are<br>
> not documented:<br>
> parameter 'pos'<br>
><br>
> /space/home/ghellings/sword-svn/src/modules/swmodule.cpp:1248: Warning: no<br>
> matching class member found for<br>
> void SWModule::filterBuffer(std::list< SWOptionFilter * > *filters,<br>
> SWBuf<br>
> &buf, SWKey *key)<br>
> Possible candidates:<br>
> virtual void SWModule::filterBuffer(OptionFilterList *filters, SWBuf<br>
> &buf,<br>
> SWKey *key)<br>
> virtual void SWModule::filterBuffer(FilterList *filters, SWBuf &buf,<br>
> SWKey<br>
> *key)<br>
> /space/home/ghellings/sword-svn/src/modules/swmodule.cpp:1260: Warning: no<br>
> matching class member found for<br>
> void SWModule::filterBuffer(std::list< SWFilter * > *filters, SWBuf<br>
> &buf,<br>
> SWKey *key)<br>
> Possible candidates:<br>
> virtual void SWModule::filterBuffer(OptionFilterList *filters, SWBuf<br>
> &buf,<br>
> SWKey *key)<br>
> virtual void SWModule::filterBuffer(FilterList *filters, SWBuf &buf,<br>
> SWKey<br>
> *key)<br>
> /space/home/ghellings/sword-svn/include/apocrypha.h:212: Warning:<br>
> documented<br>
> function `long VerseKey::atbks' was not declared or defined.<br>
> /space/home/ghellings/sword-svn/include/apocrypha.h:217: Warning:<br>
> documented<br>
> function `long VerseKey::atcps' was not declared or defined.<br>
><br>
> Once again, feedback on the documentation configuration is appreciated if<br>
> you find something missing or too much present, etc, or if you have<br>
> expertise with Doxygen (because I sure don't).<br>
><br>
> --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>