Jason McKesson | 5 May 07:02 2007
Picon

Problem with 1.5.2

Doxygen's only has up-to-date build tools for Visual Stuido 8.0. VS 7.1 
and 7.0 cannot read these files. And the VS 6.0 projects don't work 
without significant modification.

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
Jim B. | 7 May 16:35 2007

Link generation in overview pages

I found an entry asking roughly the same question in the help forum, but it was several years old and unanswered.

When using Javadoc, you can specify the –overview tag to include a project-wide overview section.  This is roughly equivalent to the Doxygen technique of adding an <at> mainpage tag to a source file, followed by a tag such as “ <at> htmlinclude overview.html”.

I created a Java source file with a class named “New1”, and created the file overview.html with the following contents:

  <body>Brief overview. A link: { <at> link New1}</body>

When I run Javadoc against my source file and specify the -overview switch pointed to my overview.html file, a link is produced on the overview page with the text string “New1” which links to the documentation for class New1.

When I run Doxygen, I get the text string “{ <at> link New1}” in my output and no link.

The first question: is there a better way to incorporate an overview page that will cause the link tags to be evaluated into an actual links the way Javadoc does?

Second question: In order to use the Javadoc overview feature you use a command line option (no tags).  This means you can add an overview page to a project without editing source files to add special tags like “ <at> mainpage”.

Would you consider adding such a switch to Doxygen so that Doxygen can produce the same overview pages as Javadoc without requiring a change to the source files (adding one or more tags)?

Extra info:  We deliver Javadoc with our product, but are considering using Doxygen for internal use.  The hope is that initially, there will be no source code changes required until we are able to get the effort moving.

Thanks!
Jim

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Iain Buchanan | 10 May 06:10 2007
Picon

Re: Patch: Aliases with Arguments (TODO #28)

Did this patch ever get into the doxygen tree?  Is anyone using it?  I'm
about to try it out, but I think I will have to patch the source
still...

thanks!

On Fri, 2006-09-29 at 17:01 -0500, Dirk Reiners wrote:
>     Hi Y'all (I've been living in Louisiana too long ;),
> 
> I wrote a little patch to support arguments in aliases. It's very simple 
> and not very elegant, but it works fine.
> 
> Usage is trivial. In the aliases arguments need to be marked with 
> ^<number>^, like this:
>  
> ALIASES      = "al1=*AL1*" \
>                "al2=*AL2:^1^*" \
>                "al3=*AL3:^1^ -> ^2^*"
> 
> When using the alias the arguments are passed in parentheses after the 
> alias (like C macros) and separated by ',' (which can be escaped if 
> necessary):
> 
> Alias with one arg: \al2(ARG) will be "*AL2:ARG*"
> Alias with one arg and escaped ',': \al2(ARG\,BLARG) will be 
> "*AL2:ARG,BLARG*"
> Alias with two args: \al3(FOO,BAR) will be "*AL3:FOO -> BAR*"
> 
> If an alias is called without () no argument substitution is done, so 
> all existing documentation should work just fine.
> 
> Currently the maximum number of arguments is fixed at 20, which 
> hopefully is enough.
> 
> The path is against current CVS.
> 
> Hope you find it useful
>   
>     Dirk
> 
> 
> 
> plain text document attachment (aliasdiff)

--

-- 
Iain Buchanan <iain at pcorp dot com dot au>

Wilner's Observation:
	All conversations with a potato should be conducted in private.

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
Robbie Gates | 10 May 09:38 2007

Re: Patch: Aliases with Arguments (TODO #28)

> Did this patch ever get into the doxygen tree?  Is anyone using it?  I'm
> about to try it out, but I think I will have to patch the source
> still...
As far as i can see from my copy of the sources (the 1.5.2 release) it
hasn't been - replaceAliases in commentcnv.l has the old QRegExp cmd
ctor argument, and the updated lex action looks like the old version.

Can you let me (via the list) know how you get on - i'm also
interested in this functionality.

 - robbie

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
Iain Buchanan | 10 May 13:09 2007
Picon

Re: Patch: Aliases with Arguments (TODO #28)

On Thu, 2007-05-10 at 17:38 +1000, Robbie Gates wrote:
> > Did this patch ever get into the doxygen tree?  Is anyone using it?  I'm
> > about to try it out, but I think I will have to patch the source
> > still...
> 
> As far as i can see from my copy of the sources (the 1.5.2 release) it
> hasn't been - replaceAliases in commentcnv.l has the old QRegExp cmd
> ctor argument, and the updated lex action looks like the old version.

Hm, this is strange, since it is still on the TODO list.  I don't know
how anyone can use aliases effectively without it!

> Can you let me (via the list) know how you get on - i'm also
> interested in this functionality.

I'm actually getting an intern to do it ;) and so far he's patched 1.4.7
successfully and made a test run ok.  1.5.x broke some latex features we
were using, so I haven't bothered with that version yet.

cya,
--

-- 
Iain Buchanan <iain at pcorp dot com dot au>

Anyone who considers protocol unimportant has never dealt with a cat.
		-- R. Heinlein 

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
Gennaro Prota | 11 May 22:53 2007
Picon

Feature request: #include<> vs. #include "" and prefixes

Hi guys,

unless I'm missing something, it seems that the only way to have
doxygen indicate the relevant include file for a class in quoted form
is to explicitly specify the header-name with a \class command.
Similarly if all the includes require a common path prefix (e.g.
"boost/"). Would it be possible to add a couple of configuration
options for this, instead?

INCLUDE_FORMAT_IS_QUOTED = {yes|no}
INCLUDE_PATH_PREFIX      = <string>

I'm not familiar with the doxygen source code but if this requires too
much time, and there's interest, I can try and prepare a patch.

Thanks in advance!

--

-- 
Gennaro Prota
https://sourceforge.net/projects/breeze/

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
Matthew Woehlke | 16 May 17:14 2007
Picon
Picon

[ATTN Dimitri] status of bug 418615?

A while back I submitted a patch to fix parsing of multiple style 
commands (i.e. '\c \e foo bar', which should make 'foo' command and 
emphasized, and leave 'bar' normal style). What ever happened with this? 
Has it been fixed?

old post: http://permalink.gmane.org/gmane.text.doxygen.devel/801
bug*: http://bugzilla.gnome.org/show_bug.cgi?id=418615

(* at least, my old post claims that's a bug report of this; gnome.org 
seems to be down ATM.)

--

-- 
Matthew
"Nobody expects the Spanish Inquisition!" -- Monty Python

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
Daniel Leidert | 18 May 21:48 2007
Picon
Picon

Possible bug in manpage creation: Minux signs are not escaped

Hello,

Consider e.g.
http://mpqc.cvs.sourceforge.net/*checkout*/mpqc/mpqc/bin/sc-config.dox
as example. The created manpages do not escape the hyphens, although
they should be (to my knowledge) and the Whatis entry is created
correctly:

> .SH NAME
> sc-config \- The sc-config program is used to obtain information about MPQC's compile time environment.

I would consider this a bug in doxygen. I didn't find an info, how to
get doxygen to escape the minus here.

Regards, Daniel

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
Dimitri van Heesch | 20 May 11:32 2007
Picon

Re: [ATTN Dimitri] status of bug 418615?

It is still on my todo list.

I have to understand your fix (or "ugly hack" as you call it) and it see what implications
it has. Since there is a workaround for the limitation, I do not consider it of the highest priority.

Regards,
   Dimitri

On 5/16/07, Matthew Woehlke <mw_triad <at> users.sourceforge.net> wrote:
A while back I submitted a patch to fix parsing of multiple style
commands (i.e. '\c \e foo bar', which should make 'foo' command and
emphasized, and leave 'bar' normal style). What ever happened with this?
Has it been fixed?

old post: http://permalink.gmane.org/gmane.text.doxygen.devel/801
bug*: http://bugzilla.gnome.org/show_bug.cgi?id=418615

(* at least, my old post claims that's a bug report of this; gnome.org
seems to be down ATM.)

--
Matthew
"Nobody expects the Spanish Inquisition!" -- Monty Python


-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Dimitri van Heesch | 20 May 11:44 2007
Picon

Re: Patch: Aliases with Arguments (TODO #28)



On 5/10/07, Iain Buchanan <iain <at> pcorp.com.au> wrote:
On Thu, 2007-05-10 at 17:38 +1000, Robbie Gates wrote:
> > Did this patch ever get into the doxygen tree?  Is anyone using it?  I'm
> > about to try it out, but I think I will have to patch the source
> > still...
>
> As far as i can see from my copy of the sources (the 1.5.2 release) it
> hasn't been - replaceAliases in commentcnv.l has the old QRegExp cmd
> ctor argument, and the updated lex action looks like the old version.

Hm, this is strange, since it is still on the TODO list.  I don't know
how anyone can use aliases effectively without it!


I'm working on official support for aliases with arguments at the moment.

To give you an idea about the syntax, here are some examples of aliases:

ALIASES        = xreflist{3}="\xrefitem \1 \"\2\" \"\3\" " \
                 reminder="\xreflist{reminders,Reminder,Reminders}" \
                 l{1}="\ref \1" \
                 l{2}="\ref \1 \"\2\"" \
                 table{1}="<table border=0 cellspacing=2 cellpadding=0>\theader{\1}"  \
                 theader{1}="<tr><th bgcolor=\"FFFF00\" colspan=3>\1" \
                 row3{3}="<tr><td>\1 <td>\2 <td>\3 </tr>" \
                 endtable="</table>" \
                 Bold{1}="<b>\1</b>" \
                 Emph{1}="<em>\1</em>"

And some code using the aliases:

/** \reminder This needs to be renamed
 *  \reminder Also a redesign would be handy
 *  See \l{Base} or \l{Base,the other class}.
 *  A nice table:
 *  \table{Heading}
 *  \row3{ cell(1\,1) , cell(1\,2) , cell(1\,3) }
 *  \row3{ cell(2\,1) , cell(2\,2) , cell(2\,3) }
 *  \endtable
 *  \Bold{Some \Emph{text} here}
 */
class Test
{
};

/** Some class */
class Base
{
};



> Can you let me (via the list) know how you get on - i'm also
> interested in this functionality.

I'm actually getting an intern to do it ;) and so far he's patched 1.4.7
successfully and made a test run ok.   1.5.x broke some latex features we
were using, so I haven't bothered with that version yet.

cya,
--
Iain Buchanan <iain at pcorp dot com dot au>

Anyone who considers protocol unimportant has never dealt with a cat.
                -- R. Heinlein


-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop