doxygen-users — List for users of doxygen

[Doxygen-users] Doxygen bug report: (pdf)latex is not run as many times as necessary

[Roberto B. <ba...@cs...>]

Doxygen writes, in the LATEX_OUTPUT a Makefile that is very useful
in order not to run (pdf)latex and makeindex by hand.
Here is one of the make rules I am talking about

refman.dvi: refman.tex doxygen.sty
        echo "Running latex..."
        latex refman.tex
        echo "Running makeindex..."
        makeindex refman.idx
        echo "Rerunning latex...."
        latex refman.tex

The problem is that (pdf)latex may have to be run multiple times
to get cross-references right.  Sometimes running it once after
makeindex is indeed enough, but must often you need to run it
twice (this is the case for the project I am working on).
In rare cases you need to run it three or more times (even though
I have never seen more than three runs to be necessary).
That is why I propose to replace the above rule by the following
and to provide a similar rule for pdflatex when USE_PDFLATEX is set
to YES:

refman.dvi: refman.tex doxygen.sty
	echo "Running latex..."
	latex refman.tex
	echo "Running makeindex..."
	makeindex refman.idx
	echo "Rerunning latex...."
	latex refman.tex
	latex_count=5
	while egrep -s 'Rerun (LaTeX|to get cross-references right)' refman.log && [ $latex_count -gt 0 ] ;\
	do \
	  echo "Rerunning latex...." ;\
	  latex refman.tex ;\
	  latex_count=`expr $latex_count - 1` ;\
	done

Notice that latex is run only if necessary and at most five times
after makeindex. This is done because (pdf)latex is not guaranteed
to be able to stabilize the cross-references.  While this happens only
in extremely pathological cases, it is better to take measures
against it.  That is what latex_count is used for.

All the best,

    Roberto

-- 
Roberto Bagnara
Computer Science Group
Department of Mathematics, University of Parma, Italy
http://www.cs.unipr.it/~bagnara/
mailto:ba...@cs...

[Doxygen-users] Doxygen bug report: namespaces and friends

[Roberto B. <ba...@cs...>]

The attached files exemplify a bug in Doxygen 1.2.11 whereby
Doxygen seems unable to match a friend function with its
documentation in the presence of namespaces.
Here is bug3.cc (certified standard conformant C++ code):

namespace N {
  class A;
  void bar(A& a);
};

//! Documenting class A.
class N::A {
private:
  int i;

public:
  void foo();
  friend void N::bar(A& a);
};

/*!
  Documentation for foo.
*/
void N::A::foo() {
}

/*!
  Documentation for bar.
*/
void N::bar(A& a) {
  ++a.i;
}

Doxygen outputs, among other things,

.../bug3.cc:13 Warning: Member N::bar of class N::A is not documented.

First, N::bar is not a member of class N::A.
Then it is not true that it is not documented.
In fact, it is documented the same way the member N::A::foo is.

To reproduce:

$ doxygen Doxyfile
$ make ps

All the best,

    Roberto

-- 
Roberto Bagnara
Computer Science Group
Department of Mathematics, University of Parma, Italy
http://www.cs.unipr.it/~bagnara/
mailto:ba...@cs...

[Doxygen-users] 1.2.11.1 Compile Error on AIX 4.3.3

[<db...@ca...>]

Hello,

I'm seeing this compile error on AIX 4.3.3 with xlc 3.6.6:

"xmlgen.cpp", line 113.29: 1540-090: (S) Syntax error - expected "<" and
found "&".
"xmlgen.cpp", line 119.14: 1540-090: (S) Syntax error - expected "<" and
found "&".
"xmlgen.cpp", line 734.5: 1540-206: (I) The previous 2 messages apply to
the definition of template
"ValStack<int>".
gmake[1]: *** [../objects/xmlgen.o] Error 1

Can anybody help me out?

Thanks.

[Doxygen-users] VHDL support for Doxygen

[Matt W. <Mat...@sp...>]

I have a project which will be developing source in both C and VHDL.  I
intend on using Doxygen for documenting the C source.  Has anyone used
Doxygen on VHDL source?  Can it be done?  (I only want to extract the
comments into a document)

Matthew E. Wolf 
[ Applications Engineer, Government Wireless ]
Spectrum Signal Processing, Inc.

t 301.459.8888 x18 // f  301.459.8887

<http://www.spectrumsignal.com>

> Confidential information may be contained in this message. 
> If you are not the addressee indicated in this message please 
> destroy this message and kindly notify the sender by reply email.
> 

[Doxygen-users] Doxygen bug report: \if does not work (with LaTeX math?)

[Roberto B. <ba...@cs...>]

The attached files exemplify a bug in Doxygen 1.2.11 whereby
the use of \if ... \endif causes the production of wrong LaTeX
output.

To reproduce:

$ doxygen Doxyfile
$ make ps

then see what happens on page 1.

All the best,

    Roberto

-- 
Roberto Bagnara
Computer Science Group
Department of Mathematics, University of Parma, Italy
http://www.cs.unipr.it/~bagnara/
mailto:ba...@cs...

[Doxygen-users] Doxygen bug report: list of related documentation pages

[Roberto B. <ba...@cs...>]

The attached files exemplify a bug in Doxygen 1.2.11 whereby,
in the LaTeX list of related documentation pages, bullets
are typeset so as to overwrite the index entries.
The bug can be seen at work both with or without
the COMPACT_LATEX option.

To reproduce:

$ doxygen Doxyfile
$ make ps

This report is about the first of a series of bugs
we have discovered while working on the Parma Polyhedra Library
(http://www.cs.unipr.it/ppl/).
The other reports will be mailed shortly.
All the best,

    Roberto

-- 
Roberto Bagnara
Computer Science Group
Department of Mathematics, University of Parma, Italy
http://www.cs.unipr.it/~bagnara/
mailto:ba...@cs...

_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Doxygen bug report: list of related documentation pages

[Roberto B. <ba...@cs...>]

The attached files exemplify a bug in Doxygen 1.2.11 whereby,
in the LaTeX list of related documentation pages, bullets
are typeset so as to overwrite the index entries.
The bug can be seen at work both with or without
the COMPACT_LATEX option.

To reproduce:

$ doxygen Doxyfile
$ make ps

This report is about the first of a series of bugs
we have discovered while working on the Parma Polyhedra Library
(http://www.cs.unipr.it/ppl/).
The other reports will be mailed shortly.
All the best,

    Roberto

-- 
Roberto Bagnara
Computer Science Group
Department of Mathematics, University of Parma, Italy
http://www.cs.unipr.it/~bagnara/
mailto:ba...@cs...

[Doxygen-users] (no subject)

[chen b. <ch...@ya...>]

I have some simple problem.

when I want to install doxygen, I met a problem. like,

[root@localhost tools]# rpm -ivh doxygen-1.2.11-1.i386.rpm 
error: failed dependencies:
        libfreetype.so.6   is needed by doxygen-1.2.11-1
        libstdc++-libc6.2-2.so.3   is needed by doxygen-1.2.11-1
        libXft.so.1   is needed by doxygen-1.2.11-1
        libXrender.so.1   is needed by doxygen-1.2.11-1

so what it mean?
what should I do?

[Doxygen-users] RTF generation problems and more

[Hood, E. <eh...@ti...>]

I checked the list archive (which by the way has no searching capabilities
due to a config error) and noticed the someone else posted problems
with loading the RTF output into Word 2000.

I am trying out v1.2.11.1 on Red Hat Linux 6.1 (or maybe 6.2).

I am not an RTF expert, but I discovered that there are extra '}'s
within the document.  These appear to cause Word 2000 to stop
processing since the first extra '}' matches the initial '{' at
the start of the document.  Therefore, there is something in the
RTF generation code output an extra '}' on a frequent basis.

I did a quick Vim macro (I'm a big Vi/Vim user) to remove the extra
'}'s.  Unfortunately, if I let it run to completion, Word 2000
gives status about converting the document, but at the end of
the document, it gives a stupid error about bad file or path (when
it should state that some formatting error occured and information
about the specific error).

If I interupt the macro before removing all unbalanced '}'s, I can
get Word 2000 to load the portion with the extra '}'s removed.
There is something at the end of the RTF document where my simple
macro cannot apply.  I do have a class with an inner public
interface, so I do not know if that puts some extra problems in
the mix.  Doing a Ctrl-A, F9 in Word does resolve all the cross
references in the RTF.  Note, errors occur because of unknown
bookmarks if this is done to the raw RTF generated by doxygen due to
the extra '}'s problem.

I've been trying doxygen on project library done in Java, and
noticed some of the following problems (which may not be specific
to Java):

. I at least noticed that the <big> tag is not supported, which
  would probably assume that <small> tag is not either.  For HTML
  output generation, these tags should be passed as-is instead
  of escaped.  It would seem straight-forward to map them to
  to appropriate styles for LaTeX and RTF output.

. Docs in <pre> tags are not formatted correctly in RTF output.
  Line breaks are messed up.

. Conversion of HTML tables in javadoc not supported in RTF.

. Numeric entity references not supported.  For example,
  &#xF9; &8218;.

. <dl> formatting in RTF output does not indent <dd> elements.

. <cite> HTML element not supported.  This could be handled like
  <i> for typsetting purposes.

. <address> HTML element not supported.  This could be handled
  as an italicized paragraph block.

. I have some javadoc with non-functional HTML form markup
  (for a servlet class).  Probably not worth supporting, but
  I figure I would mention it since the markup is not supported
  by doxygen.

. I try to generate Postscript documentation from the LaTeX output,
  but get numerous TeX errors when running make in the latex
  output directory.  If the PS or PDF output can be done, I could
  care less about the RTF stuff.  I'm not a LaTeX/TeX person,
  so I can do little to help debug.

Overall, I think doxygen is pretty slick since it does help
one achieve the goal of consistent code level documentation
on multi-language projects and its ability to generate printable
documentation.

--ewh
  
--
Earl W. Hood
Texas Instruments
eh...@ti...
972-917-1695

[Doxygen-users] Collaboration diagram

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

Hello all

As I was looking at collaboration diagrams produced by doxygen I found 
that thy are not the collaboration diagrams in sense of UML.
UML's collaboration diagrams include also the method calls.
Is it possible to include those as well ?
I know that it means more work but it would be worth it.
Now you can't be sure which all classes are used by given class.

Sequence diagram feature would be excellent but  I'm not sure how much 
work would be involved.

Thanks
	Jan

RE: [Doxygen-users] Doxygen seems lost with ATL Source. Please he lp !!!

[Prikryl,Petr <PRI...@sk...>]

Hi Jean-Marc,

I am not sure if I understand all the details that you had described,
but you probably want to read the doxygen documentation related
to the preprocessing -- see doxygen/html/preprocessing.html.
There is some example by Valter Minute & Reyes Ponce that shows
what should be inserted into your Doxyfile.

I hope this helps,
 Petr

-- 
Petr Prikryl, SKIL, spol. s r.o., pri...@sk...

> -----Original Message-----
> From:	Jean-Marc Paulin [SMTP:jm...@mi...]
> Sent:	Tuesday, October 30, 2001 12:41 PM
> To:	dox...@li...
> Subject:	[Doxygen-users] Doxygen seems lost with ATL Source. Please
> help !!!
> 
> Hi gurus,
>  
> Just new to Doxygen, and it really looks fantastic. but I am sure you all
> now that.
>  
> Anyway, I have to document some Win32/MFC/ATL code, and it sounds like I
> am missing some configuration somewhere.
[...]

[Doxygen-users] problems with \par (latex)

[Mitja U. <mit...@zr...>]

Hello!

If you use \par in such way:

/*!
 * \file
 * test
 *
 * \par This is test
 * - first item
 * - second item
 * - third item
 *
 */

in generated code you get additional \end{Desc}. (bug??? or wrong use of
par???)


Mitja

[Doxygen-users] Doxygen seems lost with ATL Source. Please help !!!

[Jean-Marc P. <jm...@mi...>]

Hi gurus,

Just new to Doxygen, and it really looks fantastic. but I am sure you =
all now that.

Anyway, I have to document some Win32/MFC/ATL code, and it sounds like I =
am missing some configuration somewhere.

Basically, Doxygen cannot pull the documentation from =
CCustomControlSite::XDocHostUIHandler::GetHostInfo() for instance.
It sounds like it can get things out from the header file, but associate =
it to the #define STDMETHOD instead of the=20
method name. I guess this is because of the #define STDMETHOD somewhere =
in atl.h (M$ stuff) but I do not know how
to get it right. thanks for any help.

Regards,

Jean-Marc




from Custsite.cpp
...  =20
<source file=3DCustsite.cpp>
/// Called at initialization
HRESULT FAR EXPORT  CCustomControlSite::XDocHostUIHandler::GetHostInfo( =
DOCHOSTUIINFO* pInfo )
{

   METHOD_PROLOGUE(CCustomControlSite, DocHostUIHandler)
   pInfo->dwFlags =3D DOCHOSTUIFLAG_NO3DBORDER;
    pInfo->dwDoubleClick =3D DOCHOSTUIDBLCLK_DEFAULT;

    return S_OK;
}

/// Called when MSHTML.DLL shows its UI
HRESULT FAR EXPORT  CCustomControlSite::XDocHostUIHandler::ShowUI(
            DWORD dwID,=20
            IOleInPlaceActiveObject * /*pActiveObject*/,
            IOleCommandTarget * pCommandTarget,
            IOleInPlaceFrame * /*pFrame*/,
            IOleInPlaceUIWindow * /*pDoc*/)
{

   METHOD_PROLOGUE(CCustomControlSite, DocHostUIHandler)
   // We've already got our own UI in place so just return S_OK
    return S_OK;
}

/// Called when MSHTML.DLL hides its UI
HRESULT FAR EXPORT  CCustomControlSite::XDocHostUIHandler::HideUI(void)
{
   METHOD_PROLOGUE(CCustomControlSite, DocHostUIHandler)
    return S_OK;
}
</source>

<source file=3DCustsite.h>
/**
<p>Local implementation of <I>IDocHostUIHandler2</I>.</p>
<p>IWebBrowser2 will query its host to find out if it implements it, and =
then use it when required. This is
used to implement our menu in the HTML view. allowing the user to select =
a section of the=20
HTML as a RegExp.</p>
*/
/// Implement IDocHostUIHandler2 for displaying our own pop-up menu in =
the Internet Explorer view
class CCustomControlSite:public COleControlSite
{
public:
   CCustomControlSite(COleControlContainer =
*pCnt):COleControlSite(pCnt){}

protected:

   DECLARE_INTERFACE_MAP();
BEGIN_INTERFACE_PART(DocHostUIHandler, IDocHostUIHandler)
/**
<p>Called by IWebBrowser2 when the user wants to display the pop-up =
menu.</p>
<p>1st Check if the user has selected some text (HTML Text). If this is =
the case
then display our pop-up menu from the Edit menu (allowing the add of a =
RegExp). If not
then let the browser follow its default behavior.</p>
<p>For some reasons, the selection tag matches the CONTEXT_MENU_CONTROL =
#define, and not=20
the expected CONTEXT_MENU_TEXTSELECT. Is this a bug ??? </p>
*/
   STDMETHOD(ShowContextMenu)(/* [in] */ DWORD dwID,
            /* [in] */ POINT __RPC_FAR *ppt,
            /* [in] */ IUnknown __RPC_FAR *pcmdtReserved,
            /* [in] */ IDispatch __RPC_FAR *pdispReserved);
   STDMETHOD(GetHostInfo)(=20
            /* [out][in] */ DOCHOSTUIINFO __RPC_FAR *pInfo);
   STDMETHOD(ShowUI)(=20
            /* [in] */ DWORD dwID,
            /* [in] */ IOleInPlaceActiveObject __RPC_FAR *pActiveObject,
            /* [in] */ IOleCommandTarget __RPC_FAR *pCommandTarget,
            /* [in] */ IOleInPlaceFrame __RPC_FAR *pFrame,
            /* [in] */ IOleInPlaceUIWindow __RPC_FAR *pDoc);
   STDMETHOD(HideUI)(void);
   STDMETHOD(UpdateUI)(void);
</source>


And the output:

<log>
Parsing file X:/TransxRX:/TransxRec/Tools/TransRec/custsite.cpp:54 =
Warning: member `AddRef' of class =
`CCustomControlSite::XDocHostUIHandler' cannot be found
X:/TransxRec/Tools/TransRec/custsite.cpp:62 Warning: member `Release' of =
class `CCustomControlSite::XDocHostUIHandler' cannot be found
X:/TransxRec/Tools/TransRec/custsite.cpp:69 Warning: no matching class =
member found for=20
  HRESULT FAR EXPORT =
CCustomControlSite::XDocHostUIHandler::QueryInterface(REFIID riid, void =
**ppvObj)
X:/TransxRec/Tools/TransRec/custsite.cpp:77 Warning: member =
`GetHostInfo' of class `CCustomControlSite::XDocHostUIHandler' cannot be =
found
X:/TransxRec/Tools/TransRec/custsite.cpp:93 Warning: member `ShowUI' of =
class `CCustomControlSite::XDocHostUIHandler' cannot be found
X:/TransxRec/Tools/TransRec/custsite.cpp:102 Warning: member `HideUI' of =
class `CCustomControlSite::XDocHostUIHandler' cannot be found
X:/TransxRec/Tools/TransRec/custsite.cpp:110 Warning: member `UpdateUI' =
of class `CCustomControlSite::XDocHostUIHandler' cannot be found
X:/TransxRec/Tools/TransRec/custsite.cpp:118 Warning: member =
`EnableModeless' of class `CCustomControlSite::XDocHostUIHandler' cannot =
be found
X:/TransxRec/Tools/TransRec/custsite.cpp:125 Warning: member =
`OnDocWindowActivate' of class `CCustomControlSite::XDocHostUIHandler' =
cannot be found
X:/TransxRec/Tools/TransRec/custsite.cpp:132 Warning: member =
`OnFrameWindowActivate' of class `CCustomControlSite::XDocHostUIHandler' =
cannot be found
X:/TransxRec/Tools/TransRec/custsite.cpp:142 Warning: member =
`ResizeBorder' of class `CCustomControlSite::XDocHostUIHandler' cannot =
be found
X:/TransxRec/Tools/TransRec/custsite.cpp:164 Warning: member =
`ShowContextMenu' of class `CCustomControlSite::XDocHostUIHandler' =
cannot be found
X:/TransxRec/Tools/TransRec/custsite.cpp:185 Warning: member =
`TranslateAccelerator' of class `CCustomControlSite::XDocHostUIHandler' =
cannot be found
X:/TransxRec/Tools/TransRec/custsite.cpp:192 Warning: member =
`GetOptionKeyPath' of class `CCustomControlSite::XDocHostUIHandler' =
cannot be found
X:/TransxRec/Tools/TransRec/custsite.cpp:201 Warning: member =
`GetDropTarget' of class `CCustomControlSite::XDocHostUIHandler' cannot =
be found
X:/TransxRec/Tools/TransRec/custsite.cpp:209 Warning: member =
`GetExternal' of class `CCustomControlSite::XDocHostUIHandler' cannot be =
found
X:/TransxRec/Tools/TransRec/custsite.cpp:221 Warning: member =
`TranslateUrl' of class `CCustomControlSite::XDocHostUIHandler' cannot =
be found
X:/TransxRec/Tools/TransRec/custsite.cpp:229 Warning: member =
`FilterDataObject' of class `CCustomControlSite::XDocHostUIHandler' =
cannot be found
X:/TransxRec/Tools/TransRec/custsite.h:45 Warning: Member =
CCustomControlSite of class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:49 Warning: Member =
DECLARE_INTERFACE_MAP of class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:64 Warning: Member STDMETHOD of =
class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:70 Warning: Member STDMETHOD of =
class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:71 Warning: Member STDMETHOD of =
class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:72 Warning: Member STDMETHOD of =
class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:73 Warning: Member STDMETHOD of =
class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:74 Warning: Member STDMETHOD of =
class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:75 Warning: Member STDMETHOD of =
class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:79 Warning: Member STDMETHOD of =
class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:83 Warning: Member STDMETHOD of =
class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:86 Warning: Member STDMETHOD of =
class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:89 Warning: Member STDMETHOD of =
class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:91 Warning: Member STDMETHOD of =
class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:95 Warning: Member STDMETHOD of =
class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:98 Warning: Member STDMETHOD of =
class CCustomControlSite is not documented.
X:/TransxRec/Tools/TransRec/custsite.h:107 Warning: Member =
CCustomOccManager of class CCustomOccManager is not documented.
</log>

[Doxygen-users] Commenttags

[Mario B. <mar...@gm...>]

Hi all,

I´ve some troubles with the detailed section in the generated doc.

I try to generate a html-output of my java-sources.
Some of the classdescriptions are commented in this way:

/****************************************
 * Parsen von DataSourcen
 * <p>
 ***************************************/
public class ....

when i view the output then there is no detailed section.
When I change the comment to:

/**
 * Parsen von DataSourcen
 * <p>
 ***************************************/
public class ....

everything is ok.

Javadoc generate the doc in both ways.

Is this a bug in doxygen or does anybody know how to solve this trouble ?
By the way: I don´t want to change all commentblocks.

With best regards,
                  Mario

-- 
GMX - Die Kommunikationsplattform im Internet.
http://www.gmx.net

Re: [Doxygen-users] DocBook/XML

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

On Fri, Oct 26, 2001 at 04:30:38PM +0200, Prikryl,Petr wrote:
> Hi Anton and others,
> 
> As far as I know, XML part of the doxygen development is 
> focused on a kind of internal intermediate format that follows
> XML syntax.  The goal is to define it so, that all the output 
> generators could use it to generate the final output form (HTML,
> LaTeX, RTF, etc.).  DocBook XML may be one example
> of another (new) output form. 

This is indeed the plan. Using DocBook XML for the internal format
is too restrictive IMHO, but I'll try to use the DocBook syntax 
whenever it makes sense, so that generating DocBook XML should be
easy. 

One of the ideas is that the internal format will include
more information than needed for any of the output formats. 
Each output generator can select the appropriate information. For
instance, I could envision a tool that generates call graphs 
based on the XML output, something I would not expect to be able
to do with standard DocBook tools.

> You are invited to share your knowledge related to XML.
> Possibly, the dox...@li...
> is better place for such discussions.

I agree.

Regards,
  Dimitri

Re: [Doxygen-users] "can't find doxfont"

[Geoff D. <gef...@di...>]

Hi,

Has anyone been able to nail a cause for this. I've been maintaining doxygen
documentation for a project & have not been able to reproduce it. But when
doxygen is run on the same code, with the same settings on another box
it generates the "can't find doxfont in . " error.

I've tried with doxygen 1.2.8.1 & 1.2.11.1 & various versions of graphvis &
have still been unable to reproduce.

Gef :]

On Mon, 1 Oct 2001 10:30:43 +0200
Jesper Bojesen <jb...@me...> wrote:

> 
> Hi,
> 
> I have a small problem with getting doxygen to cooperate with the 
> graphviz tool. In all its simplicity the problem is that when I run 
> doxygen, I get the message 
>    can't find font doxfont in . 
> from dot.  The graphs are still generated, but the font used in place of the 
> missing doxfont  is too large, so that labels wont fit in the enclosing box. 
> 
> I have confirmed that the font file doxfont.ttf is generated in the current 
> directory, by commenting the code that deletes it, and the error message 
> is printed by dot, so it is clear that dot is found. 
> 
> Any suggestions to what I can do differently to get this to work will be most
> welcome.
>  
> Version numbers are: 
>     doxygen: 1.2.6
>     graphviz: 1.7.7
> all on linux  redhat 7.0.
> 
> -- 
> 
> Jesper Bojesen
> Email: 	jb...@me...
> Phone:	(+45) 40 99 55 03
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users


--
The 80's -- when you can't tell hairstyles from chemotherapy.

Re: [Doxygen-users] DocBook/XML

[Hunter M. <hma...@vi...>]

Attached are 2 XSL stylesheets. They work against doxygen xml
output. One (test.xsl) is to be used with fop to produce pdf. The
other (dox2db.xsl) produces DocBook. See NOTEs.

THESE STYLESHEETS ARE EXTREMELY CRUDE.  :-)

I basically started teaching myself this stuff when I hurt my back
last weekend and started reading "The XSL Companion". Just yesterday I
hacked the fo example into a DocBook example.

It only formats a compound name at the top of a new page (in the pdf,
the docbook appearance depends on the stylsheet you use with it), the
compound detailed description, and then just dumps the memberdef type
and name. It's more educational than useful. I have used test.xsl to
produce a 205 page pdf (of a great deal of whitespace :-). The Docbook
example is less tested as my docbook tools/skills are still fledgling.

I am using 
	doxygen 1.2.11.1	code    -> xml
	fop     0.20.1		xsl+xml -> pdf
	saxon	(see below)	xsl+xml -> xml (docbook in this case)

The saxon I use is the saxon-catalog package from the debian "testing"
pool. I will include the package info below.

Did I mention that these are VERY CRUDE and ignore most of the info
that doxygen produces!!!!????

I hope this helps someone. I am sending this to devel (I hope) and
users. Please forgive me if you find this annoying. I will not be so
bothersome in the future.

	hunter


EXAMPLE USAGE:
	./fop.sh -xsl test.xsl -xml doxygen.xml test.pdf

	saxoncat doxygen.xml dox2db.xsl -o db.xml

NOTE: 
There are descrepancies between the doxygen XML output and the
DTD that is supplied with doxygen. Minor stuff, just be aware.

NOTE!!!! 
The raw doxygen xml output is broken. For some reason, there
are extra </highlight> tags that are thrown in before SOME
</sourcecode> tags. The following perl script fixed MY example, your
mileage may vary. A .bak backup file is made for you.

perl -pi.bak -e 's#</highlight> </sourcecode>#</sourcecode>#;' file.xml

*********** Output of "apt-cache show saxon-catalog" ***********

Package: saxon-catalog
Priority: optional
Section: contrib/text
Installed-Size: 108
Maintainer: Mark Johnson <mr...@de...>
Architecture: all
Version: 20000203-5
Depends: java-common, lib-saxon-java (>= 6.4.4), arbortext-catalog, libcrimson-java
Suggests: docbook-xsl (>= 1.45)
Filename: pool/contrib/s/saxon-catalog/saxon-catalog_20000203-5_all.deb
Size: 11646
MD5sum: ad6d14954830316f502f434c7802c63f
Description: Catalog support and wrapper the Saxon XSLT Processor
 This package provides a simple front-end to Saxon for processing XML
 source files with XSL stylesheets. Catalog support is provided by an
 extension class to Norm Walsh's Arbortext Catalog Classes.
 .
 A wrapper script for general saxon usage is also included.
 .
 This package works well for processing DocBook XML sources.
 .
 Author: Jirka Kosek <ji...@ko...>
 Homepage: http://www.kosek.cz/xml/saxon/





On Fri, Oct 26, 2001 at 07:31:30PM +0300, Anton G Sergeev wrote:
> Petr, 
> 
> my proposal is to switch output format to DocBook and use another (not 
> DoxyGen) tools to generate output forms. There are a lot of tools you can 
> use to produce HTML, HTML Help, PDF etc. from one DocBook/XML source.
> 
> With best regards,
>         Anton.
> 
> 
> 
> 
> 
> "Prikryl,Petr" <PRI...@sk...>
> 26.10.2001 17:30
> 
>  
>         To:     Anton G Sergeev <ag...@ml...>, dox...@li...
>         cc: 
>         Subject:        RE: [Doxygen-users] DocBook/XML
> 
> 
> Hi Anton and others,
> 
> As far as I know, XML part of the doxygen development is 
> focused on a kind of internal intermediate format that follows
> XML syntax.  The goal is to define it so, that all the output 
> generators could use it to generate the final output form (HTML,
> LaTeX, RTF, etc.).  DocBook XML may be one example
> of another (new) output form. 
> 
> You are invited to share your knowledge related to XML.
> Possibly, the dox...@li...
> is better place for such discussions.
> 
> See you,
>  Petr
> 
> -- 
> Petr Prikryl, SKIL, spol. s r.o., pri...@sk...
> 
> > -----Original Message-----
> > From:          Anton G Sergeev [SMTP:ag...@ml...]
> > Sent:          Friday, October 26, 2001 11:09 AM
> > To:            dox...@li...
> > Subject:               [Doxygen-users] DocBook/XML
> > 
> > Hi all,
> > 
> > IMHO there is very good DTD for computer texts including API 
> description. 
> > This is DocBook. The full information can be found on these web-sites:
> > 
> > http://www.oasis-open.org/docbook
> > http://www.docbook.org
> > http://nwalsh.com/docbook
> > http://web.oreilly.com/news/docbooklic_0901.html
> > http://docbook.sourceforge.net
> > 
> > With best regards,
> >         Anton Sergeev.
> > 
> > ========================================================================
> > Message: 2
> > Date: Wed, 24 Oct 2001 15:58:12 -0700
> > From: Hunter Marshall <hma...@vi...>
> > To: dox...@li...
> > Subject: Re: [Doxygen-users] xml
> > 
> > On Thu, Oct 18, 2001 at 09:51:04PM +0200, Dimitri van Heesch wrote:
> > > On Thu, Oct 18, 2001 at 10:26:00AM -0700, Hunter Marshall wrote:
> > > > I will begin working with a smaller case. Is the doxygen.dtd file in
> > > > doxygen-1.2.11.1/addon/xmlparse the associated DTD? 
> > > 
> > > No, it is just something that could be used as a starting point ;-)
> > > Any help on writing a proper DTD is highly welcomed.
> > 
> > After playing with xsl/fop, I think that maybe the DTD structure might
> > be an area for experimentation. For example, I am finding that the
> > numbering control in XSLT (<xsl:number>) does not go outside a
> > sequence of sibling nodes. I suppose some cool XSL hacker could do
> > it. It's not like LaTeX where you can tap your own custom counter when
> > you want the next number value in a sequence.
> > 
> > What I mean is that the numbering works well for something like
> > 
> > chap
> >  sec
> >   subsec
> >   subsec
> >  sec
> >   subsec
> > chap
> >  sec
> >   subsec
> > 
> > Whereas the doxygen DTD (at a highlevel) looks like
> > 
> > compounddef
> >  compoundname
> >  sectiondef
> >   memberdef (the dtd and the output differ on this)
> >   memberdef
> >   memberdef
> >  sectiondef
> >   memberdef
> >  detaileddescriptio
> > 
> > I don't have any suggestions yet. I am just now realizing the impact
> > of DTD design on the ease of processing. 
> > 
> >                  hunter
> > 
> > PS Should this go to doxygen-develop? Or to a smaller group than
> > doxygen-users?
> > 
> > _______________________________________________
> > Doxygen-users mailing list
> > Dox...@li...
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 
> 
> 
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 

RE: [Doxygen-users] DocBook/XML

[Anton G S. <ag...@ml...>]

Petr, 

my proposal is to switch output format to DocBook and use another (not 
DoxyGen) tools to generate output forms. There are a lot of tools you can 
use to produce HTML, HTML Help, PDF etc. from one DocBook/XML source.

With best regards,
        Anton.





"Prikryl,Petr" <PRI...@sk...>
26.10.2001 17:30

 
        To:     Anton G Sergeev <ag...@ml...>, dox...@li...
        cc: 
        Subject:        RE: [Doxygen-users] DocBook/XML


Hi Anton and others,

As far as I know, XML part of the doxygen development is 
focused on a kind of internal intermediate format that follows
XML syntax.  The goal is to define it so, that all the output 
generators could use it to generate the final output form (HTML,
LaTeX, RTF, etc.).  DocBook XML may be one example
of another (new) output form. 

You are invited to share your knowledge related to XML.
Possibly, the dox...@li...
is better place for such discussions.

See you,
 Petr

-- 
Petr Prikryl, SKIL, spol. s r.o., pri...@sk...

> -----Original Message-----
> From:          Anton G Sergeev [SMTP:ag...@ml...]
> Sent:          Friday, October 26, 2001 11:09 AM
> To:            dox...@li...
> Subject:               [Doxygen-users] DocBook/XML
> 
> Hi all,
> 
> IMHO there is very good DTD for computer texts including API 
description. 
> This is DocBook. The full information can be found on these web-sites:
> 
> http://www.oasis-open.org/docbook
> http://www.docbook.org
> http://nwalsh.com/docbook
> http://web.oreilly.com/news/docbooklic_0901.html
> http://docbook.sourceforge.net
> 
> With best regards,
>         Anton Sergeev.
> 
> ========================================================================
> Message: 2
> Date: Wed, 24 Oct 2001 15:58:12 -0700
> From: Hunter Marshall <hma...@vi...>
> To: dox...@li...
> Subject: Re: [Doxygen-users] xml
> 
> On Thu, Oct 18, 2001 at 09:51:04PM +0200, Dimitri van Heesch wrote:
> > On Thu, Oct 18, 2001 at 10:26:00AM -0700, Hunter Marshall wrote:
> > > I will begin working with a smaller case. Is the doxygen.dtd file in
> > > doxygen-1.2.11.1/addon/xmlparse the associated DTD? 
> > 
> > No, it is just something that could be used as a starting point ;-)
> > Any help on writing a proper DTD is highly welcomed.
> 
> After playing with xsl/fop, I think that maybe the DTD structure might
> be an area for experimentation. For example, I am finding that the
> numbering control in XSLT (<xsl:number>) does not go outside a
> sequence of sibling nodes. I suppose some cool XSL hacker could do
> it. It's not like LaTeX where you can tap your own custom counter when
> you want the next number value in a sequence.
> 
> What I mean is that the numbering works well for something like
> 
> chap
>  sec
>   subsec
>   subsec
>  sec
>   subsec
> chap
>  sec
>   subsec
> 
> Whereas the doxygen DTD (at a highlevel) looks like
> 
> compounddef
>  compoundname
>  sectiondef
>   memberdef (the dtd and the output differ on this)
>   memberdef
>   memberdef
>  sectiondef
>   memberdef
>  detaileddescriptio
> 
> I don't have any suggestions yet. I am just now realizing the impact
> of DTD design on the ease of processing. 
> 
>                  hunter
> 
> PS Should this go to doxygen-develop? Or to a smaller group than
> doxygen-users?
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

RE: [Doxygen-users] DocBook/XML

[Prikryl,Petr <PRI...@sk...>]

Hi Anton and others,

As far as I know, XML part of the doxygen development is 
focused on a kind of internal intermediate format that follows
XML syntax.  The goal is to define it so, that all the output 
generators could use it to generate the final output form (HTML,
LaTeX, RTF, etc.).  DocBook XML may be one example
of another (new) output form. 

You are invited to share your knowledge related to XML.
Possibly, the dox...@li...
is better place for such discussions.

See you,
 Petr

-- 
Petr Prikryl, SKIL, spol. s r.o., pri...@sk...

> -----Original Message-----
> From:	Anton G Sergeev [SMTP:ag...@ml...]
> Sent:	Friday, October 26, 2001 11:09 AM
> To:	dox...@li...
> Subject:	[Doxygen-users] DocBook/XML
> 
> Hi all,
> 
> IMHO there is very good DTD for computer texts including API description. 
> This is DocBook. The full information can be found on these web-sites:
> 
> http://www.oasis-open.org/docbook
> http://www.docbook.org
> http://nwalsh.com/docbook
> http://web.oreilly.com/news/docbooklic_0901.html
> http://docbook.sourceforge.net
> 
> With best regards,
>         Anton Sergeev.
> 
> ========================================================================
> Message: 2
> Date: Wed, 24 Oct 2001 15:58:12 -0700
> From: Hunter Marshall <hma...@vi...>
> To: dox...@li...
> Subject: Re: [Doxygen-users] xml
> 
> On Thu, Oct 18, 2001 at 09:51:04PM +0200, Dimitri van Heesch wrote:
> > On Thu, Oct 18, 2001 at 10:26:00AM -0700, Hunter Marshall wrote:
> > > I will begin working with a smaller case. Is the doxygen.dtd file in
> > > doxygen-1.2.11.1/addon/xmlparse the associated DTD? 
> > 
> > No, it is just something that could be used as a starting point ;-)
> > Any help on writing a proper DTD is highly welcomed.
> 
> After playing with xsl/fop, I think that maybe the DTD structure might
> be an area for experimentation. For example, I am finding that the
> numbering control in XSLT (<xsl:number>) does not go outside a
> sequence of sibling nodes. I suppose some cool XSL hacker could do
> it. It's not like LaTeX where you can tap your own custom counter when
> you want the next number value in a sequence.
> 
> What I mean is that the numbering works well for something like
> 
> chap
>  sec
>   subsec
>   subsec
>  sec
>   subsec
> chap
>  sec
>   subsec
> 
> Whereas the doxygen DTD (at a highlevel) looks like
> 
> compounddef
>  compoundname
>  sectiondef
>   memberdef (the dtd and the output differ on this)
>   memberdef
>   memberdef
>  sectiondef
>   memberdef
>  detaileddescriptio
> 
> I don't have any suggestions yet. I am just now realizing the impact
> of DTD design on the ease of processing. 
> 
>                  hunter
> 
> PS Should this go to doxygen-develop? Or to a smaller group than
> doxygen-users?
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] DocBook/XML

[Anton G S. <ag...@ml...>]

Hi all,

IMHO there is very good DTD for computer texts including API description. 
This is DocBook. The full information can be found on these web-sites:

http://www.oasis-open.org/docbook
http://www.docbook.org
http://nwalsh.com/docbook
http://web.oreilly.com/news/docbooklic_0901.html
http://docbook.sourceforge.net

With best regards,
        Anton Sergeev.

========================================================================
Message: 2
Date: Wed, 24 Oct 2001 15:58:12 -0700
From: Hunter Marshall <hma...@vi...>
To: dox...@li...
Subject: Re: [Doxygen-users] xml

On Thu, Oct 18, 2001 at 09:51:04PM +0200, Dimitri van Heesch wrote:
> On Thu, Oct 18, 2001 at 10:26:00AM -0700, Hunter Marshall wrote:
> > I will begin working with a smaller case. Is the doxygen.dtd file in
> > doxygen-1.2.11.1/addon/xmlparse the associated DTD? 
> 
> No, it is just something that could be used as a starting point ;-)
> Any help on writing a proper DTD is highly welcomed.

After playing with xsl/fop, I think that maybe the DTD structure might
be an area for experimentation. For example, I am finding that the
numbering control in XSLT (<xsl:number>) does not go outside a
sequence of sibling nodes. I suppose some cool XSL hacker could do
it. It's not like LaTeX where you can tap your own custom counter when
you want the next number value in a sequence.

What I mean is that the numbering works well for something like

chap
 sec
  subsec
  subsec
 sec
  subsec
chap
 sec
  subsec

Whereas the doxygen DTD (at a highlevel) looks like

compounddef
 compoundname
 sectiondef
  memberdef (the dtd and the output differ on this)
  memberdef
  memberdef
 sectiondef
  memberdef
 detaileddescriptio

I don't have any suggestions yet. I am just now realizing the impact
of DTD design on the ease of processing. 

                 hunter

PS Should this go to doxygen-develop? Or to a smaller group than
doxygen-users?

[Doxygen-users] RE: MSDN look like style

[Don M. <dmc...@in...>]

Thanks, Luke, I appreciate your posting it. And thanks to Chelpanov Alexandr
for doing it and posting it originally.

For other who might be interested, here is some basic information. This is a
patch for Doxygen version 1_2_11-20011014. It includes examples, source
code, and a pre-built win32 binary. For what it's worth, the binary passed
my virus checker. :)

The resulting version of Doxygen has a new output type, MSDN-STYLE, that
produces output that looks much like MSDN output, in terms of layout, color
and font, etc. (For the complete non-Windows geeks -- all two of you out
there :) -- MSDN stands for Microsoft Developer Network. This means it looks
like the documentation style you get with Microsoft developer tools and on
the Microsoft web site (MSDN section).)

The zip file contains a lot of examples of the output, so you can easily see
what is meant by "MSDN-like". The author acknowledges that bugs are
present - in particular, he hasn't tested the other outputs (HTML, RTF,
Latex, etc.) to make sure he hasn't broken them.

I haven't run it yet, just browsed the examples provided. It looks
interesting, and I will be playing with it more.

Don


>From: Luke Marshall <Luk...@sh...>
>To: dox...@li...
>Subject: RE: [Doxygen-users] RE: MSDN look like style
>Date: Thu, 25 Oct 2001 09:55:16 +1000
>
>I've stuck it up here if you want:
>
>http://geocities.com/mad_concepts/
>
>Cheers,
>Luke

> -----Original Message-----
> From: Don McClimans [mailto:dmc...@in...]
> Sent: Thursday, 25 October 2001 5:38 AM
> To: dox...@li...
> Subject: [Doxygen-users] RE: MSDN look like style
>
>
> I have been unable to connect to either of the URL's mentioned:
>
>   http://c_...@c-.../html/index.html
>   http://c-a-v.chat.ru/html/index.html
>
> Given the positive comments from others, I'd like to try it
> out. I suspect
> others are in the same boat. Is there anyone who has gotten
> it who could
> mirror it someplace?

Re: [Doxygen-users] hiding internal classes.

[Roberto B. <ba...@cs...>]

"Jesper K. Pedersen" wrote:
> 
> If I have an internal class for a library, is there then a way to hide it
> (i.e. make sure that it does not appear in the documentation)?

Hi Jesper,

here is the hack we use in the Parma Polyhedra Library
(http://www.cs.unipr.it/ppl/):


#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS
/*!
  This class implements conjunctions of assertions about a polyhedron.
  The assertions supported are:
  - <EM>zero-dim</EM>: the polyhedron is the zero-dimensional singleton
    \f$\Rset^0 = \{\cdot\}\f$;
  - <EM>empty</EM>: the polyhedron is the empty set;
  - <EM>constraints up-to-date</EM>: the polyhedron is correctly
    characterized by the attached system of constraints;
  ...
#endif // PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS
class Parma_Polyhedra_Library::Status {
  ...
};

Then when producing the developer's manual we have

PREDEFINED = PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

in the Doxygen configuration file.
When producing the user's manual we use a configuration
file saying

PREDEFINED =

As I said, it is a hack and I really hope there is/will be
a better way to do that.  Of course, we have the same problem
with "internal" functions, "internal" enums... anything.
All the best,

     Roberto

-- 
Roberto Bagnara
Computer Science Group
Department of Mathematics, University of Parma, Italy
http://www.cs.unipr.it/~bagnara/
mailto:ba...@cs...

[Doxygen-users] hiding internal classes.

[<bl...@kl...>]

If I have an internal class for a library, is there then a way to hide it
(i.e. make sure that it does not appear in the documentation)?

Kind Regards
Jesper.
-- 
Jesper K. Pedersen          |  Klarälvdalens Datakonsult
Senior Software Engineer    |  www.klaralvdalens-datakonsult.se
Peder Skrams Gade 27 3. tv. |
6700 Esbjerg                |  Platform-independent
Denmark                     |  software solutions

[Doxygen-users] avoid images being centered.

[<bl...@kl...>]

If I use the code 
  \image html image.png
in my documents, then a centered image is inserted in the HTML output:
  <center> <img src="image.png"> </center>

Is there a way to avoid the center tags to be generated?

thanks
Jesper.

-- 
Jesper K. Pedersen          |  Klarälvdalens Datakonsult
Senior Software Engineer    |  www.klaralvdalens-datakonsult.se
Peder Skrams Gade 27 3. tv. |
6700 Esbjerg                |  Platform-independent
Denmark                     |  software solutions

FW: [Doxygen-users] RE: MSDN look like style

[Henrik N. <He...@no...>]

I think the MSDN look like style is a big improvement!
I am also hoping that the patch will be integrated in the 'standard'
doxygen.

// Henrik N

> -----Original Message-----
> From: dox...@li...
> [mailto:dox...@li...]On Behalf Of Luke
> Marshall
> Sent: den 25 oktober 2001 01:55
> To: dox...@li...
> Subject: RE: [Doxygen-users] RE: MSDN look like style
>
>
> I've stuck it up here if you want:
>
> http://geocities.com/mad_concepts/
>
> Cheers,
> Luke
>
> > -----Original Message-----
> > From: Don McClimans [mailto:dmc...@in...]
> > Sent: Thursday, 25 October 2001 5:38 AM
> > To: dox...@li...
> > Subject: [Doxygen-users] RE: MSDN look like style
> >
> >
> > I have been unable to connect to either of the URL's mentioned:
> >
> >   http://c_...@c-.../html/index.html
> >   http://c-a-v.chat.ru/html/index.html
> >
> > Given the positive comments from others, I'd like to try it
> > out. I suspect
> > others are in the same boat. Is there anyone who has gotten
> > it who could
> > mirror it someplace?
> >
> > TIA,
> >
> > Don
> >
> >
> > _______________________________________________
> > Doxygen-users mailing list
> > Dox...@li...
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>