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 :

$ headerbrowser foo.h

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.
Conversion type could be:
  • h2h: header to HTML
  • h2x: header to XHB (XML format used in HeaderBrowser)
  • x2h: XHB to HTML
The default conversion is "h2h".
Conversion creates:
  • HTML conversion creates 'hbresult-html' directory.
  • XHB conversion creates 'hbresult.xhb' file.
$ headerbrowser -l eng *.h
Use the '-l' option for setting the output language.
Language could be:
  • eng: english
  • fr: french

Previous Page : All tags recapitulation
Return to main page

Copyright © 2000-2001  |  Licence informations