doxygen-users — List for users of doxygen

[Doxygen-users] doxygen 1.8.9 (and also 1.8.7) extremely slow for vhdl

[Walter F.J. M. <w.f...@re...>]

Hi,

I'm using doxygen to generate a 'source code browser pages' for a
medium sized VHDL project. Some is publicly visible under
    http://www.retro11.de/doxy/w11/vhd/html/hierarchy.html
Total volume is
   ~   450 files
   ~ 85000 lines

With doxygen 1.8.7 it took about 32 sec to generate the files !

With doxygen 1.8.9 this slowed down to a snake-speed crawl. Even after
more than 18 CPU hours (!!) the files aren't done. The job  isn't hung,
it's very slowly progressing, one sees a new 'Generating docs' line
very few minutes. Resource consumption seems reasonable top gives

      PR  NI    VIRT    RES    SHR S  %CPU %MEM     TIME+ COMMAND
      30  10  125660  73620   4688 R  99.8  1.8   1100:32 doxygen

I also tried doxygen 1.8.8, same observation, it proceeds, but at
a dreadfully slow pace.

In 1.8.8 the VHDL parser was changed, in 1.8.9 many VHDL fixes
were done. So my question:

    Does anybody else see such dramatic performance issues with
    doxygen 1.8.8/1.8.9 and VHDL ?


		With best regards, 	Walter

[Doxygen-users] Collaboration DIagram in Objective C

[john v. <ve...@ic...>]

I’m new at documenting my programs :-).

I’m interested in getting collaboration diagrams for objective C. So far, it seems that the only collaborators I get are for properties where the variable is an instance of a class from my project. Too often the properties are arrays or dictionaries where the class of the content is hidden.

It seems to me that using the #import statements would be a better guide to the collaborators of  a class. Is there a way to get this to happen?

Also, in some cases some - but not all - properties of the objective C base class reference important collaborators. I have in mind specifically the ‘view’ and ‘representedObject’ properties of the NSViewController class. Is there a way to include these in the collaborator diagram?

Then there is the whole issue of bindings and ‘performSelector’ and so on! 

Of course I can document these in the textual documentation for various classes and methods, but it would be nice to have a diagram that shows these dependencies. 

Thanks — now that I finally started using it, I find dOxygen a huge help.

john velman
ve...@ic...

Re: [Doxygen-users] Verilog support in Doxygen..

[borsto <bor...@ac...>]

> Is there a way to get Verilog source code parsed by Doxygen? 

With a large delay in my response,
I can provide you with a parser/filter that doxygen can call on verilog-ams
files.

I wrote it in perl and I use it on windows + doxygen 1.6.3;
this may require you to massage it a little for your configuration,
especially if you are a unix user.

I'd like to expand its functionality towards Verilog HDL, so let me know if
you still need it in a private mail.

Cheers, b



-----
when you hold a hammer, everything looks like a nail.
--
View this message in context: http://doxygen.10944.n7.nabble.com/Verilog-support-in-Doxygen-tp2819p6955.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] UML Class diagram for Fortran

[Nicolas B. <nic...@gm...>]

Hi list,

since this list restricts the maximum email size, I have put the files on
github:

https://gist.github.com/nicolasbock/c37d7184938cce7964b3

I can't get the full class hierarchy for a Fortran project out of doxygen.
The inheritance diagram I get does not show inheritance beyond one level,
i.e. it shows that c_class inherits from b_class, but it stops there
instead of further indicating that b_class inherits from a_class.
Interestingly though, the inheritance of a2_class -> a1_class -> a_class is
shown correctly.

Do I need to set something in the doxygen configuration file to make it
understand that inheritance can happen across modules?

Thanks already,

nick

Re: [Doxygen-users] \cond or \if on \addgroup

[Albert <alb...@gm...>]

Dear Roman,

I think  you should leave out the firs @endcond and the second @cond. The
first endcond will terminate the conditional block and the second cond will
start a new block and everything in between will be parsed by doxygen again.

Albert

On Wed, Dec 17, 2014 at 4:59 PM, Roman Savchenko <gm...@gm...> wrote:
>
> HI All,
>
> I want to do something like that
>
> /*
>  * @cond INTERNAL
>  * @addgroup MyInternalGroup
>  * @{
>  * @endcond
>  */
>
> //some internal doc hided with @internal
>
> /*
> * @cond INTERNAL
> * @}
> * @endcond
> */
>
> But group MyInternalGroup still generated.
> Thanks for any help.
>
> Regards,
> R. Savchenko.
>
>
> ------------------------------------------------------------------------------
> Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
> from Actuate! Instantly Supercharge Your Business Reports and Dashboards
> with Interactivity, Sharing, Native Excel Exports, App Integration & more
> Get technology previously reserved for billion-dollar corporations, FREE
>
> http://pubads.g.doubleclick.net/gampad/clk?id=164703151&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] \cond or \if on \addgroup

[Roman S. <gm...@gm...>]

HI All,

I want to do something like that

/*
 * @cond INTERNAL
 * @addgroup MyInternalGroup
 * @{
 * @endcond
 */

//some internal doc hided with @internal

/*
* @cond INTERNAL
* @}
* @endcond
*/

But group MyInternalGroup still generated.
Thanks for any help.

Regards,
R. Savchenko.

[Doxygen-users] Double entries of C variable

[Fabian C. <Cen...@in...>]

Hi

I have a project written in C and I'm documenting it with
doxygen 1.8.8 (Windows). Seems to work fine except for
a detail I can't resolve. For some variables that are in both
.c and .h files I get two documentation entries:

.h:
/*! \brief Pointer to SomeType (H-file). */
extern SomeType* const g_pPointer;

.c:
/*! \brief Pointer to SomeType (C-file). */
SomeType* const g_pPointer = ((SomeType*) 0x12345678);

This then gives me two entries in the documentation,
both pointing to the same place:

SomeType* const g_pPointer = ((SomeType*) 0x12345678)
Pointer to SomeType (C-file).
Pointer to SomeType (H-file).
Definition at line 78 of file SomeType.c.

SomeType* const g_pPointer
Pointer to SomeType (H-file).
Pointer to SomeType (H-file).
Definition at line 78 of file SomeType.c.

Changing or moving the doxy comment didn't change the
outcome. Why does doxygen generate two entries when
it knows that they are the same and can combine the
comments in the first case?

Thanks

bye  Fabi

[Doxygen-users] segfault with 1.8.8 (fwd)

[Sam V. <mr...@co...>]

I'm attaching a minimal tagfile, produced by doxygen 1.8.8, that triggers  
the segfault when it tries to read it back in.

Generate a stock doxyfile with doxygen -g, and stick it into a TAGFILE.

gdb points the finger to a null pointer dereference.

#1  0x00000000005a8ff8 in NamespaceDef::addInnerCompound (this=0x1423230,
    d=0x0) at namespacedef.cpp:136
136	  m_innerCompounds->append(d->localName(),d);
(gdb) p d
$3 = (Definition *) 0x0


#0  Definition::localName (this=this@entry=0x0) at definition.cpp:1386
#1  0x00000000005a8ff8 in NamespaceDef::addInnerCompound (this=0x1423230,
    d=0x0) at namespacedef.cpp:136
#2  0x0000000000414104 in buildScopeFromQualifiedName (name=…, level=2,
    lang=SrcLangExt_Unknown, tagInfo=0x1422620) at doxygen.cpp:1041
#3  0x0000000000428acb in addClassToContext (rootNav=rootNav@entry=0x14673b0)
    at doxygen.cpp:1315
#4  0x0000000000429826 in buildClassList (rootNav=0x14673b0)
    at doxygen.cpp:1392
#5  0x00000000004297dd in buildClassList (rootNav=0x14226a0)
    at doxygen.cpp:1394
#6  0x00000000004297dd in buildClassList (rootNav=0x141c6d0)
    at doxygen.cpp:1394
#7  0x00000000004454d5 in parseInput () at doxygen.cpp:10981
#8  0x0000000000409ad9 in main (argc=1, argv=0x7fffffffe558) at main.cpp:37

[Doxygen-users] Files with doubly-dotted extensions

[Andrew L. <dr...@me...>]

By adding *.h.in and *cc.in to the FILE_PATTERNS, I can get these almost-C files documented usefully. (They are subject to CMake configure_file, after which they are placed in the build tree. I don't want to treat the build tree as a Doxygen input location, because it's not in the same place, even with respect to current directory, on each developer's machine. Even more true if the developer is trying to document just a subdirectory of the main source tree.)

However, in EXTENSION_MAPPINGS, h.in=C does not seem to work. The file is included, but not analyzed as C source. I have to use in=C. This becomes a problem if I ever want to have Doxygen work on py.in files, which have to be mapped to the Python generator.

[Doxygen-users] Doxygen Directory Layout , Naming Conventions and Custom Fonts

[Ondine K. <ok...@gm...>]

Hi all,

I'm a new user to Doxygen and this list and just updated to Doxygen 1.88 on
Mac OSX 10.9 (Mavericks). I hope you'll forgive me if these questions are
basic. I've spent some time combing through the manual and user group
archives, but haven't found recent answers (2012-2014) that allow me to be
able to configure correctly to Doxygen best practices.

I have a project with the following Directory Layout:

myproject

*--docs*

*html*

*latex*

--src

--doxygen.config

--mainpage.md

--CMakeLists.txt

--README

I'm trying to customize:

A) Font family for both html and latex outputs (and mainpage.md, a markdown
file)
B) Stylesheets for both html and latex outputs  (and mainpage.md)

Caveats:

--  At the moment I'm focusing on the HTML output (and .md file) as a
priority.
--   I don't want to overwrite the doxygen.css and tabs.css, as my
understanding is that it is not a "Best Practice."  True or False?
--  I also believe that multiple stylesheets and .html files are supported,
but there is an order?
--  Lastly I know I can EXCLUDE the Fonts and Stylesheets (where ever they
live) in the doxygen.config, but want our client to be able to replicate
the Customized results when they re-run the doxygen command.
--  Our engineers don't want these items (Fonts and Stylesheets)  in the
src directory. (where they are currently as I test results)

So the questions are:

1) Is there a standard place to put the Font Family folder (Directory
containing 8 weights, bold, italic, bold italic, etc), where it won't get
"blown away" upon a command line rerun of: 'doxygen doxygen.config'?

2) Is there a standard Naming Convention and place to put the:
customstylesheets.css  customtabs.css new_header.html  new_footer.html
where it won't get "blown away"?

4) Should I have also added HTML_HEADER and HTML_FOOTER in addition to the
above?
I read this:
http://www.stack.nl/~dimitri/doxygen/manual/config.html#config_html
But am not understanding the entirety of the solution.

doxygen -w html new_header.html new_footer.html new_stylesheet.css
YourConfigFile

Should I have all of the following?:

   1. new_header.html  Styles the HTML Header
   2. new_footer.html  Styles the HTML Footer
   3. customstylesheet.css or/aka new_stylesheet.css  Styles everything
   else html and latex?
   4. customtabs.css   Styles the Tabs


5) Is my Config file setup correctly?

doxygen.config:

#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------

HTML_OUTPUT            = html
HTML_FILE_EXTENSION    = .html
HTML_HEADER            =
HTML_FOOTER            =
HTML_STYLESHEET        =
HTML_EXTRA_STYLESHEET  = customstylesheet.css customtabs.css
HTML_EXTRA_FILES       = Gotham Rounded
HTML_COLORSTYLE_HUE    = 220
HTML_COLORSTYLE_SAT    = 100
HTML_COLORSTYLE_GAMMA  = 80
HTML_TIMESTAMP         = YES
HTML_DYNAMIC_SECTIONS  = NO
HTML_INDEX_NUM_ENTRIES = 100
GENERATE_DOCSET        = NO
DOCSET_FEEDNAME        = "Doxygen generated docs"
DOCSET_BUNDLE_ID       = org.doxygen.Project
DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
DOCSET_PUBLISHER_NAME  = Publisher
GENERATE_HTMLHELP      = NO
CHM_FILE               =
HHC_LOCATION           =
GENERATE_CHI           = NO
CHM_INDEX_ENCODING     =
BINARY_TOC             = NO
TOC_EXPAND             = NO
GENERATE_QHP           = NO
QCH_FILE               =
QHP_NAMESPACE          = org.doxygen.Project
QHP_VIRTUAL_FOLDER     = doc
QHP_CUST_FILTER_NAME   =
QHP_CUST_FILTER_ATTRS  =
QHP_SECT_FILTER_ATTRS  =
QHG_LOCATION           =
GENERATE_ECLIPSEHELP   = NO
ECLIPSE_DOC_ID         = org.doxygen.Project
DISABLE_INDEX          = NO
GENERATE_TREEVIEW      = NO
ENUM_VALUES_PER_LINE   = 4
TREEVIEW_WIDTH         = 250
EXT_LINKS_IN_WINDOW    = NO
FORMULA_FONTSIZE       = 10
FORMULA_TRANSPARENT    = YES
USE_MATHJAX            = NO
MATHJAX_FORMAT         = HTML-CSS
MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
MATHJAX_EXTENSIONS     =
MATHJAX_CODEFILE       =
SEARCHENGINE           = YES
SERVER_BASED_SEARCH    = NO
EXTERNAL_SEARCH        = NO
SEARCHENGINE_URL       =
SEARCHDATA_FILE        = searchdata.xml
EXTERNAL_SEARCH_ID     =
EXTRA_SEARCH_MAPPINGS  =

#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX         = YES
LATEX_OUTPUT           = latex
LATEX_CMD_NAME         = latex
MAKEINDEX_CMD_NAME     = makeindex
COMPACT_LATEX          = NO
PAPER_TYPE             = letter
EXTRA_PACKAGES         = /Users/ok/myproject/src/Gotham Rounded
LATEX_HEADER           =
LATEX_FOOTER           = docs/latex/MyPreamble.tex
LATEX_EXTRA_FILES      =
PDF_HYPERLINKS         = YES
USE_PDFLATEX           = YES
LATEX_BATCHMODE        = NO
LATEX_HIDE_INDICES     = NO
LATEX_SOURCE_CODE      = YES
LATEX_BIB_STYLE        = plain

#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------

CLASS_DIAGRAMS         = YES
MSCGEN_PATH            =
DIA_PATH               =
HIDE_UNDOC_RELATIONS   = YES
HAVE_DOT               = YES
DOT_NUM_THREADS        = 0
DOT_FONTNAME           = Gotham Rounded
DOT_FONTSIZE           = 10
DOT_FONTPATH           = .src/Gotham Rounded
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = YES
GROUP_GRAPHS           = YES
UML_LOOK               = NO
UML_LIMIT_NUM_FIELDS   = 10
TEMPLATE_RELATIONS     = YES
INCLUDE_GRAPH          = YES
INCLUDED_BY_GRAPH      = YES
CALL_GRAPH             = NO
CALLER_GRAPH           = NO
GRAPHICAL_HIERARCHY    = YES
DIRECTORY_GRAPH        = YES
DOT_IMAGE_FORMAT       = png
INTERACTIVE_SVG        = NO
DOT_PATH               =
DOTFILE_DIRS           =
MSCFILE_DIRS           =
DIAFILE_DIRS           =
DOT_GRAPH_MAX_NODES    = 50
MAX_DOT_GRAPH_DEPTH    = 0
DOT_TRANSPARENT        = YES
DOT_MULTI_TARGETS      = NO
GENERATE_LEGEND        = YES
DOT_CLEANUP            = YES

Thanks in advance , and sorry for the long laundry list!

Ondine

[Doxygen-users] How to create a page which does not appear anywhere in left hand menu

[didje <dia...@pd...>]

I have a library for which I am generating doxygen documentation.
There is a module (module_A) in that library which contains a description of
various details in relation to this module (on generated page
group_moduleA.html).
I want to add several pages to give additional details about that module,
which I will then link to from the module page. However, I do not want those
pages to be visible in any of the left hand menu. I only want them to be
linked to from the group_moduleA.html page and nowhere else.
Is there any way to do that?

I cannot use \page, as a page will be added in the left hand menu if I do
that.





--
View this message in context: http://doxygen.10944.n7.nabble.com/How-to-create-a-page-which-does-not-appear-anywhere-in-left-hand-menu-tp6947.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Case sensitive names

[Albert <alb...@gm...>]

Dear Petr,

One of the things on the list is keeping the case of the variable, but this
is not easy as it also involves changing quite a bit in changing the search
strategy as well. Same accounts (especially for multi language programs)
changing all the names to uppercase or having an extra switch to do this.

Best Regards,

Albert

On Tue, Dec 9, 2014 at 4:39 PM, Petr Parik <pet...@se...> wrote:

> Dear Albert,
>
> thank you, I have no problem with that. But could there be an additional
> switch in Doxyfile, say, UPPERCASE_NAMES = YES, which would cause the names
> in the output to be all uppercase (or lowercase, for that matter).
>
> Right now, if the code is in uppercase (as is mine), the output contains a
> mix of upper/lowercase names, specifically, member function/subroutine
> argument names are in uppercase, while everything else is lowercase. I also
> have to write lowercase links, e.g., #var instead of #VAR, which creates
> inconsistency between the comments and the code.
>
> So, is there a possibility to change the Doxygen output routine to
> consistently force upper/lowercase?
>
> Best regards,
>
> Petr
>

[Doxygen-users] Is the ordered lists support broken in 1.8.8?

[Stefan L. <kai...@ex...>]

Hi.

I have tried out the first example code snippet from
http://www.stack.nl/~dimitri/doxygen/manual/lists.html.
That code reads like this:
  /*!
   *  A list of events:
   *    - mouse events
   *         -# mouse move event
   *         -# mouse click event\n
   *            More info about the click event.
   *         -# mouse double click event
   *    - keyboard events
   *         1. key down event
   *         2. key up event
   *
   *  More text here.
   */

And the result should look like this:

"A list of events:

    mouse events
        mouse move event
        mouse click event
        More info about the click event.
        mouse double click event
    keyboard events
        key down event
        key up event

More text here."

However the actually generated HTML code with Doxygen 1.8.8 reads like
this:
<p></p>
<p>A list of events:</p><ul>
<li>mouse events<ol type="1">
<li>mouse move event</li>
<li>mouse click event<br />
 More info about the click event.</li>
<li>mouse double click event</li>
</ol>
</li>
<li>keyboard events 1. key down event 2. key up event</li>
</ul>
<p>More text here. </p>

Obviously Doxygen has only generated an ordered list when using the "-#"
style, but the "1."  style seems to be broken.

I am getting the same results with 1.8.7, 1.8.5 and 1.8.3.1 - have not
tested it with any other release than these.

Does this work for you?
Do I have to set any Doxygen options to certain values to make it work?
Markdown support is turned off in my configuration.

Kind regards,
Stefan.

-- 
--
Exit Games | www.exitgames.com | @exitgames | +49 40 413 596 0

Executive Christof Wegmann, CTO
Trade Registry / Amtsgericht Hamburg, Germany HRB 85991

++ Add Chat: http://j.mp/PhotonChat
++ Start Turnbased: http://j.mp/PhotonTurnbased
++ Unity Networking that just works: http://j.mp/PhotonUnity
++ Follow http://twitter.com/exitgames for Photon announcements

[Doxygen-users] using copydoc in Java

[Massimo B. <mas...@gm...>]

Hello there!

I'm happily documentaing my java code with Doxygen (which is awesome).
Recently I encounter a problem that I think it's a bug (but it might also
be my inexperience).

I have documented a java interface method, for example like this:

public interface InterfaceTest {

 /**documentation
  *
  */
 public void InterfaceMethod();
}

And I have a implementing class, where I want to add additional
documentation. My first guess was to use the command \copydoc, like this:

public class ClassTest implementing InterfaceTest {

 /** \copydoc InterfaceTest::InterfaceMethod()
  *
  * additional documentation
  */
 @Override
 public void InterfaceMethod(){
   //do stuff here...
 }
}

The problem is that the output shows only the additional documentation, as
if there was no copydoc command. Doxygen dosn't show any warning in the
output console.
So, am I doing something wrong?

Thanks for all the answers!

Re: [Doxygen-users] Case sensitive names

[albert <alb...@gm...>]

Dear Petr,

For the, internal, search algorithm it was necessary (or better said
currently the easiest way) to convert all names to lower case. This is a bit
of an inconvenience and should be changed in the future (when time permits).

Albert



--
View this message in context: http://doxygen.10944.n7.nabble.com/Case-sensitive-names-tp6942p6943.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Case sensitive names

[Petr P. <pet...@se...>]

Hello,

I use Doxygen 1.8.8 on Windows x64 for documenting Fortran code. The 
problem is it automatically lowercases all function/subroutine/variable 
names (except in headings). Is there a way to keep the names uppercase?

Thanks,

Petr Parik

Re: [Doxygen-users] "Global" call graph possible?

[Richard D. <Ri...@Da...>]

On 12/3/14, 8:12 AM, Georg Jaehnig wrote:
> Hi,
>
> I wonder if it is possible to generate one call graph for the whole
> project: one that contains all the functions and their calls in one
> graph. Is it?
>
> I already hacked something together using the XML output to create my
> own DOT file but much more convenient would be a switch within
> Doxyfile.
>
The call graph of main()?

If you have a library, I think you will need to make a "dumy" function 
that calls all the root api functions in the library.

-- 
Richard Damon

[Doxygen-users] "Global" call graph possible?

[Georg J. <ge...@ja...>]

Hi,

I wonder if it is possible to generate one call graph for the whole
project: one that contains all the functions and their calls in one
graph. Is it?

I already hacked something together using the XML output to create my
own DOT file but much more convenient would be a switch within
Doxyfile.

-- 
Georg | http://www.serchilo.net - search with shortcuts

Re: [Doxygen-users] VHDL Blocks

[jchang_endiag <jc...@en...>]

Thanks, but unfortunately that did not work.

Darius K emailed me and explained that code blocks don't work for process
documentation.  He suggested using `@code` and `@endcode` as a work-around,
which does work.



--
View this message in context: http://doxygen.10944.n7.nabble.com/VHDL-Blocks-tp6910p6939.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] RTF - lack of source code

[albert <alb...@gm...>]

Please subscribe to the mailing list so you will get your question easily
accessible to a broader audience.



--
View this message in context: http://doxygen.10944.n7.nabble.com/RTF-lack-of-source-code-tp6936p6938.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Identifying Objective-C code from the XML

[Dimitri v. H. <do...@gm...>]

Hi Michael,

I've already implemented the language attribute, see this commit
https://github.com/doxygen/doxygen/commit/e986e0039de21791bd1fbb1f59b13f58c4a46324

Feedback about the usefulness is very much welcome of course.

Regards,
  Dimitri

> On 30 Nov 2014, at 12:35 , Michael Jones <m.p...@gm...> wrote:
> 
> Hi,
> 
> I'm sorry to have gone quiet. Do you feel that you have time to look at this? Or do you think that it is a reasonable feature for someone new to the code base to try? I could attempt a pull-request and you could provide feedback?
> 
> Kind regards,
> Michael
> 
> On Sun, Oct 26, 2014 at 4:02 PM, Michael Jones <m.p...@gm...> wrote:
> Hi,
> 
> Thank you for the quick response. I'm glad you think the project is interesting and I am very grateful for the links you provide to Breathe from your documentation.
> 
> It is good to know Doxygen stores the language for the definitions. For Breathe, it certainly would be useful to have the source language in the XML output as it seems the code needs to make similar rendering decisions as your HTML output code does. I'm not sure how best to represent it or at what level to have it specified. I imagine you have a good feel for that. Being inexperienced at Objective-C I get confused, but I guess the ability to mix Objective-C and plain C style declarations means it would have to go on each definition rather than any higher up.
> 
> If you think it is acceptable for the XML output then great, if you can see a better approach then I'd be happy to learn. Thanks again.
> 
> Kind regards,
> Michael
> 
> 
> On Sun, Oct 26, 2014 at 11:54 AM, Dimitri van Heesch <do...@gm...> wrote:
> Hi Michael,
> 
> > On 26 Oct 2014, at 12:15 , Michael Jones <m.p...@gm...> wrote:
> >
> > I am the maintainer of an open source project called Breathe which relies on the excellent xml output from Doxygen to include Doxygen processed code & comment information in Sphinx documentation.
> 
> A very interesting project!
> 
> > Breathe has generally focussed on C & C++ output but recently we've had requests to support Objective-C code as well which has very different formatting. As Breathe doesn't know any better it attempts to stick the information in the XML together as if it is C style output and so produces a bit of a mess for Objective-C style declarations.
> >
> > I am curious how doxygen tracks that a particular declaration should be output as Objective-C and how that might be reflected in the XML output in such as way that Breathe might take advantage of it.
> >
> > Unfortunately, I know very little of Objective-C so I don't really know what I am looking for. That said, from an inspection of the XML output for an example Objective-C interface the only clues I can see are that the 'ids' begin with 'interface' and that there are strangely placed square brackets and colons in the definition & param values :)
> >
> > Is the 'interface' prefix sufficient information in this case? Is there another way of determining that Objective-C might be involved?
> 
> Doxygen internally keeps track of which language a symbol is written in (see Definition::getLanguage()).
> This information is partly based on the file extension (and EXTENSION_MAPPING setting) and is for Objective-C also based on specific keywords found in the header file.
> 
> So far this information is not written to the XML output, but it would not be hard to add this if that would help you.
> 
> Regards,
>   Dimitri
> 
> 
> 

Re: [Doxygen-users] Identifying Objective-C code from the XML

[Michael J. <m.p...@gm...>]

Hi,

I'm sorry to have gone quiet. Do you feel that you have time to look at
this? Or do you think that it is a reasonable feature for someone new to
the code base to try? I could attempt a pull-request and you could provide
feedback?

Kind regards,
Michael

On Sun, Oct 26, 2014 at 4:02 PM, Michael Jones <m.p...@gm...>
wrote:

> Hi,
>
> Thank you for the quick response. I'm glad you think the project is
> interesting and I am very grateful for the links you provide to Breathe
> from your documentation.
>
> It is good to know Doxygen stores the language for the definitions. For
> Breathe, it certainly would be useful to have the source language in the
> XML output as it seems the code needs to make similar rendering decisions
> as your HTML output code does. I'm not sure how best to represent it or at
> what level to have it specified. I imagine you have a good feel for that.
> Being inexperienced at Objective-C I get confused, but I guess the ability
> to mix Objective-C and plain C style declarations means it would have to go
> on each definition rather than any higher up.
>
> If you think it is acceptable for the XML output then great, if you can
> see a better approach then I'd be happy to learn. Thanks again.
>
> Kind regards,
> Michael
>
>
> On Sun, Oct 26, 2014 at 11:54 AM, Dimitri van Heesch <do...@gm...>
> wrote:
>
>> Hi Michael,
>>
>> > On 26 Oct 2014, at 12:15 , Michael Jones <m.p...@gm...>
>> wrote:
>> >
>> > I am the maintainer of an open source project called Breathe which
>> relies on the excellent xml output from Doxygen to include Doxygen
>> processed code & comment information in Sphinx documentation.
>>
>> A very interesting project!
>>
>> > Breathe has generally focussed on C & C++ output but recently we've had
>> requests to support Objective-C code as well which has very different
>> formatting. As Breathe doesn't know any better it attempts to stick the
>> information in the XML together as if it is C style output and so produces
>> a bit of a mess for Objective-C style declarations.
>> >
>> > I am curious how doxygen tracks that a particular declaration should be
>> output as Objective-C and how that might be reflected in the XML output in
>> such as way that Breathe might take advantage of it.
>> >
>> > Unfortunately, I know very little of Objective-C so I don't really know
>> what I am looking for. That said, from an inspection of the XML output for
>> an example Objective-C interface the only clues I can see are that the
>> 'ids' begin with 'interface' and that there are strangely placed square
>> brackets and colons in the definition & param values :)
>> >
>> > Is the 'interface' prefix sufficient information in this case? Is there
>> another way of determining that Objective-C might be involved?
>>
>> Doxygen internally keeps track of which language a symbol is written in
>> (see Definition::getLanguage()).
>> This information is partly based on the file extension (and
>> EXTENSION_MAPPING setting) and is for Objective-C also based on specific
>> keywords found in the header file.
>>
>> So far this information is not written to the XML output, but it would
>> not be hard to add this if that would help you.
>>
>> Regards,
>>   Dimitri
>>
>>
>

Re: [Doxygen-users] ?? for page numbers in the indices

[Albert <alb...@gm...>]

I've just pushed a proposed solution as pull request 252 to github.

On Mon, Nov 10, 2014 at 12:22 AM, Komal S [via Doxygen] <
ml-...@n7...> wrote:

> Hi Albert,
>
> Setting CREATE_SUBDIRS to NO worked for me.
>
> Thank you for your help with this.
>
> Komal
>
> ------------------------------
>  If you reply to this email, your message will be added to the discussion
> below:
>
> http://doxygen.10944.n7.nabble.com/for-page-numbers-in-the-indices-tp6895p6902.html
>  To unsubscribe from ?? for page numbers in the indices, click here
> <http://doxygen.10944.n7.nabble.com/template/NamlServlet.jtp?macro=unsubscribe_by_code&node=6895&code=YWxiZXJ0LnRlc3RzQGdtYWlsLmNvbXw2ODk1fC0yMTA5MjkzMjA4>
> .
> NAML
> <http://doxygen.10944.n7.nabble.com/template/NamlServlet.jtp?macro=macro_viewer&id=instant_html%21nabble%3Aemail.naml&base=nabble.naml.namespaces.BasicNamespace-nabble.view.web.template.NabbleNamespace-nabble.view.web.template.NodeNamespace&breadcrumbs=notify_subscribers%21nabble%3Aemail.naml-instant_emails%21nabble%3Aemail.naml-send_instant_email%21nabble%3Aemail.naml>
>

Re: [Doxygen-users] @startuml size of generated image for Latex/PDF

[Albert <alb...@gm...>]

I've just created pull request 251 which handles also this problem.

On Mon, Nov 24, 2014 at 8:35 PM, Matej Kenda <mat...@gm...> wrote:

> Albert,
>
> That’s great!
>
> I can try new features as soon as they will be available.
>
> Regards,
>
> Matej
>
> > On 24. nov. 2014, at 19.13, Albert <alb...@gm...> wrote:
> >
> > Hi Matej,
> >
> > This is currently not possible, but I'm working on it (it will be
> similar to \image and also applicable for other external graphing
> commands) . Hopefully I can create a patch in the next few days.
> >
> > Albert
> >
> > On Mon, Nov 24, 2014 at 4:47 PM, Matej Kenda <mat...@gm...> wrote:
> > Hi,
> >
> > It is very nice that PlantUML keywords were integrated into Doxygen.
> >
> > Generated images are sometimes too wide and are not completely visible
> on the page.
> >
> > Is there a way to control the size of the generated images that are
> included into the Latex/PDF files in a similar fashion as it can be done
> for \image tags (witdh=\textwidth)?
> >
>
>

[Doxygen-users] Asciidoctor/Asciidoc support in Doxygen?

[Schalk Cronjé <ys...@gm...>]

Given that Doxygen already supports Markdown I was wondering how much 
extra work it would be to do something along similar lines to support 
the more powerful Asciidoc (http://www.asciidoctor.org) markup.

There is already a doclet that allows Javadoc 
(https://github.com/asciidoctor/asciidoclet) to include Asciidoc in code 
documentation, so I would think that something similar could be done for 
Doxygen.

What do people think?

-- 
Schalk W. Cronjé
Twitter / Ello / Toeter : @ysb33r