View Single Post
  #1 (permalink)  
Old 03-19-2006
g00fy g00fy is offline
Registered User
 
Name: Salvania
Organization: Salvania
Project: Database systems
 
Join Date: Dec 2005
Posts: 45
Send a message via ICQ to g00fy
-->
Lightbulb "Patch" for using doxygen for slicefiles

Hereby attached you can find a little "howto" how to use DoxyGen to generate documentation for your project:

This is how I got it working:

1. Install Cygwin (www.cygwin.com), check that doxygen and sed is installed.
Code:
$ sed --version
GNU sed version 4.1.5
$ doxygen --version
1.4.6
2. Create a doxygen-script (I will assume you called it 'slice2doxy')
a] Make a small doxygen script, which only generates HTML files:
Code:
EXTRACT_ALL            = YES
QUIET                  = YES
FILE_PATTERNS          = *.ice
INPUT_FILTER           = "sed -f sed.script "
GENERATE_LATEX         = NO
b] Or get the full configuration file by running the following command:
Code:
doxygen -s -g slice2doxy
And edit it by hand to have all the options you want (but be sure it has the above options in it!)

3. Create a sed-script (I assume you call it sed.script):
Code:
# Skip C-style commenting
/\/\*/ , /\*\//b
/\/\/\(.*\)/b

s/module/namespace/
s/local//
s/idempotent//
s/dictionary/map/
s/sequence/vector/

#parse local interface
/interface/ , /{/    {
    /interface/ {
        #change interface to class
        s/interface\(.*\)/class \1/
    }
#change extends
    s/extends/: public/
#add public before every keyword, but not {
    /{/!s/,\(.*\)/, public \1/g
    s/{/{public:/
}

s/nonmutating\(.*)\)/\1 const/

/throws/,/;/ {
    s/throws/throw(/
    s/;/);/
}
4. Generate the HTMLs (or whatever you had in mind)
Code:
$ doxygen slice2doxy

If any questions, please fire ahead ;-)

PS: I made this little howto because I still couldn't figure out how to use docbook...
__________________
Steven Van Ingelgem
Salvania [http://www.salvania.be/]
Product Descr.: Statistical data analysis

Last edited by g00fy : 03-20-2006 at 03:32 AM.
Reply With Quote