Doxygen user discussions and queries

Dimitri van Heesch | 1 Feb 2005 07:57

Re: Class member documentation not turning up as expected.

On Mon, 31 Jan 2005 10:26:18 -0600 (CST), Chris Green <greenc <at> fnal.gov> wrote:
> Hi,
> 
> I'm sure I'm doing something silly, but the attached tarfile contains a
> small test case from my codebase where I'm providing detailed information
> for class member functions, but it is not appearing in the documentation
> for the class. The link from the brief description takes one to the
> catch-all "modules" page for the group in which the class resides.

If you put all members explicitly in a group than this is indeed the
behaviour you get.
If you want them to appear in the class, then don't group the members,
only the class.

Regards,
  Dimitri

-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl

headers

Chris Green | 1 Feb 2005 17:12

Re: Class member documentation not turning up as expected.

Hi,

> If you put all members explicitly in a group than this is indeed the
> behaviour you get.
> If you want them to appear in the class, then don't group the members,
> only the class.

Bingo! I've been grouping entire header files with:

\addtogroup <group>
\{
\}

so that'll be the problem.

Thanks so much for your help,
Chris.

>
> Regards,
>  Dimitri
>
>
> -------------------------------------------------------
> This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
> Tool for open source databases. Create drag-&-drop reports. Save time
> by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
> Download a FREE copy at http://www.intelliview.com/go/osdn_nl
> _______________________________________________
> Doxygen-users mailing list

(Continue reading)

headers

Brian P. Byrne | 2 Feb 2005 14:35

Finer control over HTML Output

I was wondering if there was a way to specify explicitly what styles to
assign to the various portions of the output for HTML.

For instance, the \warning option and the \bug option produce use the
same css class.  If I wanted to make warnings red, and bugs blue, I
wouldn't be able to specify that.

Will this require a code hack?  Or is there a
-produce_crazy_amounts_of_css option that I am missing?

(I am willing to sacrifice other output formats if needed)

Thanks,
Brian Byrne

-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl

headers

Albert Chin | 2 Feb 2005 15:40

Removing parentheses from generated filenames

Is it possible to get doxygen to avoid use of parentheses in
filenames? Packaging software with parentheses in filename is
impossible using the native IRIX package manager as parentheses in the
file listing has special meaning.

Failing that, where in the source can I replace use of parentheses?

--

-- 
albert chin (china <at> thewrittenword.com)

-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl

headers

Jens Miltner | 2 Feb 2005 21:19

some feature requests

I have two feature requests for doxygen:

(1) I've come to like the left-hand-side tree view once I discovered 
that option. However, I have some scripts that automatically take me to 
the documentation for a class by assembling the html file name from the 
class name and this results in a page that only shows the content 
frame, but not the navigational tree view frame. Apple usually has a 
link "Show TOC" on their documentation pages, and I'd really love to 
see something similar in the html generated by doxygen when using the 
tree view:
If the tree view is displayed a link "Hide tree" could allow to show 
the pages without the tree view frame and when viewing without frames, 
a link "Show tree" would allow to display the tree again. Not sure how 
feasible this toggle feature is, but at least a "Show tree" link would 
be helpful...

(2) When clicking the link for some member function in a class 
documentation, the anchor for this member is right next to the start of 
the documentation text, not at the beginning of the line (or the 
left-hand side of the page). This often times results in slightly 
horizontally scrolled display when clicking the link and I have to 
scroll back to be able to view everything properly. This may have to do 
with the style sheet I use, and I don't know whether there's any way 
around this problem, but it sure is annoying!

(3) When searching for classes, most of the time a couple of hundred 
links are returned, since the class names are pervasive. It would be 
nice if there was some way to search for the 
class/struct/namespace/etc. documentation explicitely, e.g. entering 
"#class FooBar" would search for a class definition of "FooBar", but

(Continue reading)

headers

Weddle, ScottX R | 3 Feb 2005 16:56

Class List hyperlink missing from Doxygen Output

Hello,

I’m having a problem getting the Class List hyperlink to be generated for a class I’ve declared. This class is exported and is declared with the keyword __declspec(dllexport). Using this keyword seems to make Doxygen not generate the Class List hyperlink. I’ve included the files that make up the project, the doxygen config file, a text file with warning messages. Unfortunetly the mail server is not allowing zip files to be attached to email.

Am I doing something wrong or is this a bug?

doxygen version: 1.3.9.1

OS: MS Windows XP Version 4.0 (2014.23)

Thanks,

Scott

Scott R. Weddle

Contract Software Engineer

Kelly IT

503 712-8667

C:/DoxygenTests/ExportedClassDeclaration/ExportedClassDec.cpp:9: Warning: documented function
`CExportedClassDec::CExportedClassDec' was not defined.
C:/DoxygenTests/ExportedClassDeclaration/ExportedClassDec.cpp:13: Warning: Member main() of
file ExportedClassDec.cpp is not documented.

Attachment (ExportedClassDec.cpp): application/octet-stream, 244 bytes

Attachment (ExportedClassDec.dsp): application/octet-stream, 3521 bytes

Attachment (ExportedClassDec.dsw): application/octet-stream, 555 bytes

Attachment (ExportedClassDec.h): application/octet-stream, 181 bytes

Attachment (ExportedClassDecConfig): application/octet-stream, 8 KiB

headers

Dimitri van Heesch | 3 Feb 2005 17:19

Re: Class List hyperlink missing from Doxygen Output

On Thu, 3 Feb 2005 07:56:59 -0800, Weddle, ScottX R
<scottx.r.weddle <at> intel.com> wrote
> 
> I'm having a problem getting the Class List hyperlink to be generated for a
> class I've declared.  This class is exported and is declared with the
> keyword __declspec(dllexport).  Using this keyword seems to make Doxygen not
> generate the Class List hyperlink.  I've included the files that make up the
> project, the doxygen config file, a text file with warning messages. 
> Unfortunetly the mail server is not allowing zip files to be attached to
> email.

If you read the manual (in particular this part
http://www.stack.nl/~dimitri/doxygen/preprocessing.html) you should
have known the answer 

Regards,
  Dimitri

-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl

headers

Bob | 4 Feb 2005 15:50

Cross Reference


Hello all, We are new to Doxygen and the C development environment here. The 
software we use now is all in assembler and we have lots of tools to work 
with it but we are moving to C. We have a tool that will allow someone to 
find out say all the program segments that call a certain macro. Is there a 
way in Doxygen to get this kind of information. Say all the C files that 
contain a particular header file?

--

-- 
_______________________________________________________________
Thanks, Bob

YahooIM: bobif
AOLIM: bobifmd
ICQ: 111083556

MCSE and CNE trained, but use LINUX, declare your PC a Microsoft free zone

-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl

headers

Dan Gass | 4 Feb 2005 15:47

Re: Image and html link

> i want to include into my docs some images and its really no problem with
> the \image command. 
> 
> My question is now how could the image works as html link also? 

Did you try using the \anchor near the \image and use \ref to hyperlink to it?

If you want the image on its own page try this:

\page somePage
\anchor someAnchor
\image someImage.jpg

-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl

headers

Kai Klenovsek | 4 Feb 2005 17:51

AW: Image and html link


>> i want to include into my docs some images and its really no problem
with
>> the \image command. 
>> 
>> My question is now how could the image works as html link also? 

> Did you try using the \anchor near the \image and use \ref to
hyperlink to > it?
Yes i tried it with \ref but it was no good idea.

> If you want the image on its own page try this:

> \page somePage
> \anchor someAnchor
> \image someImage.jpg

I think this is not what i need. I need an absolut link like
http://www.sourceforge.net behind the image. Maybe its not possible.

-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl

41	May 2013
83	April 2013
75	March 2013
76	February 2013
84	January 2013
60	December 2012
37	November 2012
56	October 2012
55	September 2012
64	August 2012
97	July 2012
69	June 2012
81	May 2012
121	April 2012
88	March 2012
77	February 2012
43	January 2012
60	December 2011
46	November 2011
72	October 2011
84	September 2011
90	August 2011
95	July 2011
54	June 2011
76	May 2011
67	April 2011
59	March 2011
77	February 2011
57	January 2011
53	December 2010
36	November 2010
66	October 2010
94	September 2010
67	August 2010
84	July 2010
86	June 2010
67	May 2010
37	April 2010
52	March 2010
70	February 2010
51	January 2010
48	December 2009
87	November 2009
79	October 2009
88	September 2009
82	August 2009
44	July 2009
56	June 2009
123	May 2009
84	April 2009
75	March 2009
115	February 2009
68	January 2009
37	December 2008
93	November 2008
62	October 2008
79	September 2008
115	August 2008
57	July 2008
79	June 2008
58	May 2008
73	April 2008
58	March 2008
115	February 2008
161	January 2008
74	December 2007
63	November 2007
74	October 2007
56	September 2007
78	August 2007
82	July 2007
80	June 2007
65	May 2007
112	April 2007
125	March 2007
97	February 2007
69	January 2007
45	December 2006
46	November 2006
82	October 2006
94	September 2006
90	August 2006
99	July 2006
143	June 2006
48	May 2006
55	April 2006
125	March 2006
72	February 2006
86	January 2006
63	December 2005
128	November 2005
140	October 2005
115	September 2005
106	August 2005
80	July 2005
106	June 2005
142	May 2005
114	April 2005
107	March 2005
76	February 2005
76	January 2005
98	December 2004
106	November 2004
69	October 2004
100	September 2004
104	August 2004
164	July 2004
64	June 2004
55	May 2004
55	April 2004
118	March 2004
71	February 2004
77	January 2004
54	December 2003
80	November 2003
108	October 2003
121	September 2003
97	August 2003
131	July 2003
129	June 2003
155	May 2003
114	April 2003
187	March 2003
122	February 2003
116	January 2003
67	December 2002
68	November 2002
97	October 2002
106	September 2002
98	August 2002
93	July 2002
80	June 2002
20	May 2002

Mon	Tue	Wed	Thu	Fri	Sat	Sun

	1	2	3	4	5	6
7	8	9	10	11	12	13
14	15	16	17	18	19	20
21	22	23	24	25	26	27
28