Extending architecture documentation
William Horn <[email protected]>
| Newsgroups | gmane.text.doxygen.devel |
|---|---|
| Message-ID | <[email protected]> |
As part of a class project, I've been working on extending the existing doxygen architecture information. I wanted to let people know about what I've been doing to get feedback and see if I should put together a patch of the changes/additions I've done. I added an optional install step in the manual that talks about running doxygen on itself, and updated the current "internals" page to reference the developer documentation. I don't have these changes online, but mention them to help provide context. Then I integrated the existing documentation into the Doxyfile that builds the documentation for doxygen, adding additional links, making some corrections, and elaborating on some points. So in my processed html files (based on 9-December version in CVS, with the html files available at http://netfiles.uiuc.edu/horn/www/doxygen) the architecture diagram is on the main page, and I moved the details off to separate pages, which are now cross-linked to the doxygen files and classes. I also updated the documentation for a few classes (like BufStr), but that was taking a while, so I concentrated more on starting to provide file-level comments (the file list is starting to have more details). I also moved some doxygen comments from lex files into header files, since the .cpp files generated from the lex files are not scanned by the current Doxyfile. I'm still working on revising some of the content (and adding more content), and the goals of my project for my class may not be quite the same as what is needed/helpful to the doxygen community. But I'm certainly willing to figure out how to use patch to submit the modifications if there is any interest. And feel free to provide any feedback. Thanks, William Horn ------------------------------------------------------------------------- Take Surveys. Earn Cash. Influence the Future of IT Join SourceForge.net's Techsay panel and you'll get the chance to share your opinions on IT & business topics through brief surveys - and earn cash http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV