Header Browser's Documentation : Running the program
|
Create documentation
When you have a ready to use version of Header Browser, you could execute it from the command line to create documentation. The default output is HTML, with the particular Header Browser's five columns view, which is really fast and easy to use to explore APIs. See these examples :
Create a 'hbresult-html' directory in the current one, and put in it the HTML documentation resulting of the foo.h header file. $ headerbrowser *.h
Same as previous, but the documentation contains all header files. $ headerbrowser -o ../tmp foo.h
Use the '-o' option for setting the directory where 'hbresult-html' will be created. $ headerbrowser -t h2h *.h
Use the '-t' option for setting the conversion type. $ headerbrowser -l eng *.h
Use the '-l' option for setting the output language.
Return to main page | ||
Copyright © 2000-2001 | | | Licence informations |