[Doxygen-users] Using <PRE> with Doxygen (got a problem!)

[Asko K. <Ask...@fi...>]

Hi, everyone!

Short version:     :>

I'd want ALL text that is extracted from my source files into Doxygen's
ouput to retain the source code formatting, that is, to be presented as =
a
'<PRE>' block in the HTML output. This should happen automatically, =
since
inserting <PRE> and </PRE> per each function messes up the source all =
too
much.

Long version:=20

I'm evaluating Doxygen for extracting documentation from an existing =
source
base. The functions already have a "header block" above their code so =
not
many changes should be necessary. Also, I want to preserve as much of =
the
current formatting as possible to keep comments easy to read in source =
code
as well.

Here's a sample comment block (unmodified):

	/*-------------------------------------
	* FlexLib_MakeDir()
	*
	* Returns:  TRUE if the directory already existed or could be
created.
	*
	* Notes:    Unlike the normal 'MakeDir()', this function is capable
of
	*           creating several levels of directory names if necessary.
	*--------------------------------------
	*/
	bool
	FlexLib_MakeDir( const char* path_and_possible_filename )
	{
	...

Simply by adding '/*!' in the beginning, I will get the comments into
Doxygen output. However (and here's where the problems begin) since I'm =
not
using the '\returns' etc. doxygen tags, the output is messy (no =
linefeeds
etc.) so I add '<pre> as well.

	/*! <pre>
	*-------------------------------------
	* FlexLib_MakeDir()
	*
	* Returns:  TRUE if the directory already existed or could be
created.
	*
	* Notes:    Unlike the normal 'MakeDir()', this function is capable
of
	*           creating several levels of directory names if necessary.
	*--------------------------------------
	*/
	bool
	FlexLib_MakeDir( const char* path_and_possible_filename )
	{
	...

Now I get the output nice but also a lot of warnings about missing =
'</pre>'
tags. Adding them will make the code look messy - don't want to do =
that.

In my opinion, a 'USE_SOURCE_FORMATTING' configuration would do the =
trick.
Has anyone else faced a similar situation and how did you solve it? =
Sorry if
I've missed something but I tried to read the docs carefully before =
posting
here! :)

- Asko

P.S. Also, a more straightforward PDF generation on Win32 would be
appreciated but I guess Linux would be a "more suitable" platform for
that...

--
Asko Kauppi                  ask...@fi...
Flextronics Design Finland   tel. +358 205 345 251
P.O.Box 23 (Jaakontie 1)     fax. +358 205 345 332
FIN-39200 Kyr=F6skoski         reg.no 572.960


###########################################

This message has been scanned by F-Secure Anti-Virus for Microsoft =
Exchange.