headers
ricky.marek | 1 Oct 2002 09:51

Is it possible to ignore specific lines in doxygen comments?

Hello Friends,

Is it possible to make doxygen ignore a specific line in all function
comments? (I guess this
can be done using an alias).

My company code-conventions requires that the comment will include the
function name prefixed with a string FUNCTION:, like in the following
example:
   /**
    * FUNCTION: UART_Initialize()
    *
    * \brief Initializes the Serial Port to 19200 for Polled mode access.
    *
    * Serial Port will be reinitialized by actual loaded code.
    *
    * \returns Nothing
    *
    */
   void UART_Initialize(void)
   {
       ...
   }

I would like "doxygen" to ignore the line containing the FUNCTION: string.
Is this possible.

Thanks.

--- Ricky Marek                      -*- Mode: Another-Unix-Hacker -*-
(Continue reading)

Permalink | Reply | 0 comments |
headers
Andrew Zabolotny | 1 Oct 2002 11:03
Picon

Doxygen & output file encoding

Good day!

I've encountered a problem with doxygen and don't know how to solve it. Maybe 
somebody can give me a hint.

The root of the problem is that for Russian there are numerous character 
encodings, in particular in Windows codepage 1251 is used, Unix is using 
KOI8-R and DOS & OS/2 is using codepage 866.

I'm using doxygen under OS/2, Windows and Linux. But I don't want to re-encode 
all my header files every time I doxygen them under a different OS. Thus I've 
chosen the KOI8-R encoding and I'm writing all my documentation files in that 
encoding.

Now when I'm launching doxygen from Windows, I'm getting almost everything 
okay, except the strings autogenerated by doxygen. They are all in cp1251 (the 
standard Windows encoding) while I need them in koi8-r. Thats even more sad 
because the original strings are compiled in koi8-r inside doxygen (e.g. the 
original Russian translation uses the encoding I need) but doxygen re-encodes 
it to cp1251. So how I can tell doxygen not to touch the encoding (and maybe 
there is a general way to specify the output encoding?).

I don't know how the translation is exactly done, but I think it is using Qt 
for this. I don't know any details on Qt, so maybe there is a generic way for 
all Qt programs? Would the LANG variable work?

-------------------------------------------------------
This sf.net email is sponsored by: DEDICATED SERVERS only $89!
Linux or FreeBSD, FREE setup, FAST network. Get your own server 
today at http://www.ServePath.com/indexfm.htm
(Continue reading)

Permalink | Reply | 0 comments |
headers
Andrew Zabolotny | 1 Oct 2002 13:32
Picon

Doxygen & output file encoding

Good day!

Okay, I have been told about the INPUT_FILTER setting, I've set it to a program 
that re-encodes the input from koi8-r to cp1251. It works, except that it 
doesn't work for examples! That is, the files specified with the  <at> example 
keyword aren't piped through INPUT_FILTER! Is it a feature or a bug? Maybe for 
 <at> example is there a different keyword?

-------------------------------------------------------
This sf.net email is sponsored by: DEDICATED SERVERS only $89!
Linux or FreeBSD, FREE setup, FAST network. Get your own server 
today at http://www.ServePath.com/indexfm.htm
Permalink | Reply | 0 comments |
headers
Oliver Schoenborn | 1 Oct 2002 21:52
Picon
Picon
Favicon

list management

Hi Dimitri and doxygen-users:

I notice that when I click on reply, the reply goes to the poster rather
than the list. This a really a pitty because quite often seeing the
replies to a question is interesting, if only to know whether a poster
has received a reply to their post. Few people think of doing "reply
all" instead of just "reply".

So, would it be possible to configure the list manager software so that
it sets the "reply-to" field of emails posted to the list to
"doxygen-users..." instead of the original poster's email address? I
don't know if this is a controversial suggestion, perhaps others
(Dimitri?) have a different view.

Thanks,
Oliver

-------------------------------------------------------
This sf.net email is sponsored by: DEDICATED SERVERS only $89!
Linux or FreeBSD, FREE setup, FAST network. Get your own server 
today at http://www.ServePath.com/indexfm.htm
Permalink | Reply | 3 comments |
headers
Dimitri van Heesch | 1 Oct 2002 22:16
Picon
Favicon

Re: list management

On Tue, Oct 01, 2002 at 03:52:19PM -0400, Oliver Schoenborn wrote:
> Hi Dimitri and doxygen-users:
> 
> I notice that when I click on reply, the reply goes to the poster rather
> than the list. This a really a pitty because quite often seeing the
> replies to a question is interesting, if only to know whether a poster
> has received a reply to their post. Few people think of doing "reply
> all" instead of just "reply".
> 
> So, would it be possible to configure the list manager software so that
> it sets the "reply-to" field of emails posted to the list to
> "doxygen-users..." instead of the original poster's email address? I
> don't know if this is a controversial suggestion, perhaps others
> (Dimitri?) have a different view.

Mailman can be configured to do this, but the last couple of times
I tried to enable this it was disabled again by sourceforge 
(probably to avoid spam/bounces), so I can't seem to change this.

Regards,
  Dimitri

-------------------------------------------------------
This sf.net email is sponsored by: DEDICATED SERVERS only $89!
Linux or FreeBSD, FREE setup, FAST network. Get your own server 
today at http://www.ServePath.com/indexfm.htm
Permalink | Reply | 0 comments |
headers
Glenn Maxey | 1 Oct 2002 22:26

RE: list management

Its present functionality is how many other lists operate.

In some lists that I frequent, the "reply to sender" has cut down a lot
of chatter that the whole list really didn't need to see, which they did
when reply sent it back out to the list.

I like it like it is, because I don't want to have to edit out addresses
in the reply field for direct responses. I've gotten used to doing
"reply-all" when it is for the world.

Just MHO and not a flame.

> -----Original Message-----
> From: Oliver Schoenborn [mailto:oliver.schoenborn <at> utoronto.ca]
> Sent: Tuesday, October 01, 2002 1:52 PM
> To: doxygen-users <at> lists.sourceforge.net
> Subject: [Doxygen-users] list management
> 
> 
> Hi Dimitri and doxygen-users:
> 
> I notice that when I click on reply, the reply goes to the 
> poster rather
> than the list. This a really a pitty because quite often seeing the
> replies to a question is interesting, if only to know whether a poster
> has received a reply to their post. Few people think of doing "reply
> all" instead of just "reply".
> 
> So, would it be possible to configure the list manager 
> software so that
(Continue reading)

Permalink | Reply | 0 comments |
headers
Tim Lesher | 1 Oct 2002 23:18

Re: list management

On Tue, Oct 01, 2002 at 03:52:19PM -0400, Oliver Schoenborn wrote:
> So, would it be possible to configure the list manager software so that
> it sets the "reply-to" field of emails posted to the list to
> "doxygen-users..." instead of the original poster's email address? I
> don't know if this is a controversial suggestion, perhaps others
> (Dimitri?) have a different view.

Yes, is is a controversial suggestion. :-)

This is a long-standing question for mailing list administrators.  A
few years ago, two essays pretty much crystallized the points for and
against:

Anti:  
http://www.unicom.com/pw/reply-to-harmful.html

Pro:
http://www.metasystema.org/essays/reply-to-useful.mhtml

Personally, I fall into the anti-camp; the mailing lists I administer
leave the reply-to alone.  

--

-- 
Tim Lesher <tim <at> lesher.ws>
http://www.lesher.ws

-------------------------------------------------------
This sf.net email is sponsored by: DEDICATED SERVERS only $89!
Linux or FreeBSD, FREE setup, FAST network. Get your own server 
today at http://www.ServePath.com/indexfm.htm
(Continue reading)

Permalink | Reply | 1 comment |
headers
FOURCADE Patrick | 2 Oct 2002 11:14
Favicon

(no subject)

Hi !

I use doxygen to document a Java Project.
The class "master" agregate a collection of "children" classes. The java
component used for the collection is Vector. So, doxygen make a link between
master and Vector.

How can I hide this link and retrieve the link between "Master" and
"children" ( in documentation / in graph ) ?

sample :

public class Children{
}

public class Master{
	//I will put here, Children instances
	Vector agregate = new Vector();
}

Thanks !

-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
Permalink | Reply | 0 comments |
headers
Stefan Wahl | 2 Oct 2002 15:28
Picon

How to link to foo(const int*)?

Hi there, it's me again!

I'm still in trouble with the automatic link generation of doxygen. Can anyone tell me how to link to a
function like foo(const int*)? "bla bla foo(const int*) bla bla" will not work and "bla bla
foo(constint*) bla bla" even less.

I know there was already a post some days ago, but there was no reply. (which leads us to yesterday's
discussion about list management ;-)

Thanks in advance!
Stefan

//////////////////////////////////////////////////////////////////////////// 
/*! 
    \brief  Mail signature
    \author Stefan Wahl
    \since  doxygen 1.12.10
    \note   Please reply to the list. That's why it exists.
 */ 
////////////////////////////////////////////////////////////////////////////

-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
Permalink | Reply | 0 comments |
headers
Stefan Wahl | 2 Oct 2002 16:17
Picon

Bug in \link foo::foo constructor \endlink

(and again ...) Hi there!

It seams that I found a funny bug. 

\link foo::foo constructor \endlink

is parsed as 

\link foo::foo const ructor \endlink (please note the space in const ructor!)

and thus results in a warning and a missing link.

Workaround: "\link foo::foo Constructor \endlink" with a upper case "C"

I using doxygen 1.2.17.

Stefan

BTW: Shall bugs be posted to doxygen-users, doxygen-develop or both and is there a up-to-date list of bugs
available online?

//////////////////////////////////////////////////////////////////////////// 
/*! 
    \brief  Mail signature
    \author Stefan Wahl
    \since  doxygen 1.12.10
    \note   Please reply to the list. That's why it exists.
 */ 
////////////////////////////////////////////////////////////////////////////
(Continue reading)

Permalink | Reply | 0 comments |

Gmane