doxygen-develop

[Doxygen-develop] Doxygen - don't remove whitespace

[<al...@ic...>]

Hello Doxygen developers,
    I would like to modify the source code for Doxygen so that white space in 
special documentation blocks is not removed.  This may be as simple as 
modifying a couple source files but my problem is that I am unfamiliar with 
flex and bison.  Here is a more concrete example of what I mean:

(from my source code)
/**
/* Abstract:
/*   This function performs calculations for the new viewing frustum
/*
/* Note:
/*   This function expects the *window pointer to point to the current view
*/

*window calcFrustum(Window* win)



In the corresponding entry for the generated man page, the whitespace, 
newlines, and asterisks are removed and it appears as:

*window calcFrustum(Window* win)

  Abstract: This function performs calculations for the new viewing frustum

  Note: This function expects the *window pointer to point to the current view




However, I would like it to only have stripped the asterisk (and preferrable 
replace it with whitespace):

*window calcFrustum(Window* win)

  Abstract:
    This function performs calculations for the new viewing frustum

  Note:
    This function expects the *window pointer to point to the current view

Can someone provide incite as to how I can go about changing the source so that 
whitespace is not removed?  Any help would be greatly appreciated.

-Allen
al...@ic...

[Doxygen-develop] Re:Doxygen - don't remove whitespace

[Jan R. <jan...@co...>]

Hi Allen,

I think that you are asking a little bit more the a preserving of the 
white spaces.

Even if the white spaces are preserved it would not mean anything in 
the context of HTML.
There has to be HTML tags corresponding to the white space characters.
Example <br> for a new line, &nbsp;  for multiple spaces etc.

On the other hand there can be demand for not preserving white spaces 
because of rigid
rules of writing the source code (80 characters per line max. etc.).

Be careful what do you wish for.

Jan

> Hello Doxygen developers,
>     I would like to modify the source code for Doxygen so that white 
> space in
> special documentation blocks is not removed.  This may be as simple as
> modifying a couple source files but my problem is that I am unfamiliar 
> with
> flex and bison.  Here is a more concrete example of what I mean:
>
> (from my source code)
> /**
> /* Abstract:
> /*   This function performs calculations for the new viewing frustum
> /*
> /* Note:
> /*   This function expects the *window pointer to point to the current 
> view
> */
>
> *window calcFrustum(Window* win)
>
>
>
> In the corresponding entry for the generated man page, the whitespace,
> newlines, and asterisks are removed and it appears as:
>
> *window calcFrustum(Window* win)
>
>   Abstract: This function performs calculations for the new viewing 
> frustum
>
>   Note: This function expects the *window pointer to point to the 
> current view
>
>
>
>
> However, I would like it to only have stripped the asterisk (and 
> preferrable
> replace it with whitespace):
>
> *window calcFrustum(Window* win)
>
>   Abstract:
>     This function performs calculations for the new viewing frustum
>
>   Note:
>     This function expects the *window pointer to point to the current 
> view
>
> Can someone provide incite as to how I can go about changing the 
> source so that
> whitespace is not removed?  Any help would be greatly appreciated.
>
> -Allen
> al...@ic...

RE: [Doxygen-develop] Doxygen - don't remove whitespace

[Paul B. <pb...@ka...>]

  This can probably be done if you use HTML to lay out exactly what you
want the comment to look like.  Doxygen does quite a bit of massaging of
the input text, so keeping the whitspace you're talking about intact might
be tricky.  (I dug through the lex portions a few years ago, fun stuff but
not really where I'd want to do any casual hacking..)
  Consider using @brief in place of Abstract, which lets Doxygen
intelligently format your comments in whatever output format you like.
Also, putting @note instead of Note: lets Doxygen know that it's a note
specifically, which it will format properly with a bold heading and such.
@note has a few cousins, in the form of @warning, @bug and @todo, the
latter two of which have the added bonus of being able to be pulled into
separate pages to give you lists of known bugs or work items.
  As a side note, you may want to consider dropping the prefix / on each
line - that's starting a nested comment which isn't strictly allowed in C.
Some compilers accept it without comment and some will choke.

  -P

--
Apologies for sending this from Outlook - my employer's views don't
necessarily reflect my own in any way.

-----Original Message-----
From: dox...@li...
[mailto:dox...@li...]On Behalf Of
al...@ic...
Sent: Wednesday, July 16, 2003 6:29 PM
To: dox...@li...
Cc: al...@ic...
Subject: [Doxygen-develop] Doxygen - don't remove whitespace


Hello Doxygen developers,
    I would like to modify the source code for Doxygen so that white space
in
special documentation blocks is not removed.  This may be as simple as
modifying a couple source files but my problem is that I am unfamiliar
with
flex and bison.  Here is a more concrete example of what I mean:

(from my source code)
/**
/* Abstract:
/*   This function performs calculations for the new viewing frustum
/*
/* Note:
/*   This function expects the *window pointer to point to the current
view
*/

*window calcFrustum(Window* win)



In the corresponding entry for the generated man page, the whitespace,
newlines, and asterisks are removed and it appears as:

*window calcFrustum(Window* win)

  Abstract: This function performs calculations for the new viewing
frustum

  Note: This function expects the *window pointer to point to the current
view




However, I would like it to only have stripped the asterisk (and
preferrable
replace it with whitespace):

*window calcFrustum(Window* win)

  Abstract:
    This function performs calculations for the new viewing frustum

  Note:
    This function expects the *window pointer to point to the current view

Can someone provide incite as to how I can go about changing the source so
that
whitespace is not removed?  Any help would be greatly appreciated.

-Allen
al...@ic...



-------------------------------------------------------
This SF.net email is sponsored by: VM Ware
With VMware you can run multiple operating systems on a single machine.
WITHOUT REBOOTING! Mix Linux / Windows / Novell virtual machines at the
same time. Free trial click here: http://www.vmware.com/wl/offer/345/0
_______________________________________________
Doxygen-develop mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-develop

Re: [Doxygen-develop] Doxygen - don't remove whitespace

[Dimitri v. H. <di...@st...>]

On Wed, Jul 16, 2003 at 03:29:01PM -0700, al...@ic... wrote:
> Hello Doxygen developers,
>     I would like to modify the source code for Doxygen so that white space in 
> special documentation blocks is not removed.  This may be as simple as 
> modifying a couple source files but my problem is that I am unfamiliar with 
> flex and bison.  

This can already be done by putting a <pre>...</pre> block around your text.

Regards,
  Dimitri