Gavin Radolan | 28 Apr 01:26 2015

References and automatic numbering for figures and tables

Hello,

I'm using Doxygen to create a reference manual. Input is markdown. Output is LaTeX and html. Currently using Doxygen 1.8.8.

I'm wondering if there are any plans for Doxygen to support automatic numbering of figures and tables, with referencing capability from the markdown text?

For example, behavior similar to the <at> section command's LaTeX output. But separate enumeration for figures and another separate enumeration for tables. And with the enumeration showing up in both LaTeX and html output.

Syntax might be something like this,

At the figure:

           ![fig_name](images/fig_growth_vs_time.png   "Growth rate vs time")

or maybe

          ![](images/fig_growth_vs_time.png   "Growth rate vs time")
          <at> figure fig_name "Growth rate vs time"

The first example is preferable for it's simplicity, but maybe it's difficult to have ![Caption text ] used for multiple purposes...

At the table:

<at> table tab_name Growth rate data 2009 - 2014

| Year | Growth Rate|
|:------:|-----------------:|
| 2009|         0.3245  |
....whatever....
    
In the body text:

The growth rate for the last five years is shown in \ref tab_name. As can be seen in /ref fig_name, the growth rate is logarithmic.

In the generated pdf/html:

The growth rate for the last five years is shown in Table 93: Growth rate 2009 - 2014. As can be seen in Figure 125: Growth rate vs time, the growth rate is logarithmic.

So "Figure N" and "Table M" are automatically generated and pre-pended to the caption for each figure/table in the document. And you can link to any figure or table anyplace in the doc using a /ref tag. 

I've noticed some users implement similar functionality with post-processing scripts or other "add-on" tools, such as doxynum. I could do likewise, but first, wanted to ask whether or not there are plans to have such functionality "built-in" to Doxygen - and if so, approximately when?

Kind regards,

Gavin Radolan


------------------------------------------------------------------------------
One dashboard for servers and applications across Physical-Virtual-Cloud 
Widest out-of-the-box monitoring support with 50+ applications
Performance metrics, stats and reports that give you Actionable Insights
Deep dive visibility with transaction tracing using APM Insight.
http://ad.doubleclick.net/ddm/clk/290420510;117567292;y
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
johnk | 13 Apr 19:11 2015
Picon

linking to doxygen

I'd like to link to Doxygen pages from a wiki.  Currently, we do that by 
generating all the documentation in the top-level directory.  This is 
less than ideal as it results in over 48000 files in a single 
directory.  Doxygen allows for the creation of sub-directories to 
alleviate this, but the mapping doesn't seem straight-forward.

Several javascript files are generated by Doxygen that look like they 
could provide a look-up table, but I've been investigating hierarchy.js 
and have been unable to figure out how it's generated, nor how it's 
used.  Given my inability to discover how the file is generated and 
used, I'm a little reluctant to make use of it for fear it might 
disappear in some future release.  I've been poking at this for a while 
now, and haven't uncovered any answers yet.

Is there a known method for linking to the appropriate document using 
the name of the class/file/namespace/etc. as a reference?

------------------------------------------------------------------------------
BPM Camp - Free Virtual Workshop May 6th at 10am PDT/1PM EDT
Develop your own process in accordance with the BPMN 2 standard
Learn Process modeling best practices with Bonita BPM through live exercises
http://www.bonitasoft.com/be-part-of-it/events/bpm-camp-virtual- event?utm_
source=Sourceforge_BPM_Camp_5_6_15&utm_medium=email&utm_campaign=VA_SF
johnk | 6 Apr 16:58 2015
Picon

doxygen and standard C++ library

Dimitri, as I work on some enhancements for Doxygen, is there any reason 
I shouldn't use std as opposed to "qtools"?  The first enhancement I 
did, some additional capabilities for markdown tables (column and row 
spans), I used std.  The PlantUML enhancements I'm working on would 
really benefit from std, but I wanted to be sure there wasn't a reason 
not to implement things that way.

------------------------------------------------------------------------------
BPM Camp - Free Virtual Workshop May 6th at 10am PDT/1PM EDT
Develop your own process in accordance with the BPMN 2 standard
Learn Process modeling best practices with Bonita BPM through live exercises
http://www.bonitasoft.com/be-part-of-it/events/bpm-camp-virtual- event?utm_
source=Sourceforge_BPM_Camp_5_6_15&utm_medium=email&utm_campaign=VA_SF
johnk | 2 Apr 21:07 2015
Picon

seg fault in doxygen.cpp (1.8.8 / 1.8.9.1)

There are numerous debug statements in doxygen.cpp using an unchecked 
templSpec.data() which causes seg faults.  Should be changed to:

templSpec.isEmpty()?"":templSpec.data()

e.g.
           Debug::print(Debug::Classes,0,
                        "    New undocumented base class `%s' 
baseClassName=%s templSpec=%s isArtificial=%d\n",
biName.data(),baseClassName.data(),templSpec.data(),isArtificial
                       );

becomes

           Debug::print(Debug::Classes,0,
                        "    New undocumented base class `%s' 
baseClassName=%s templSpec=%s isArtificial=%d\n",
biName.data(),baseClassName.data(),templSpec.isEmpty()?"":templSpec.data(),isArtificial
                       );

------------------------------------------------------------------------------
Dive into the World of Parallel Programming The Go Parallel Website, sponsored
by Intel and developed in partnership with Slashdot Media, is your hub for all
things parallel software development, from weekly thought leadership blogs to
news, videos, case studies, tutorials and more. Take a look and join the 
conversation now. http://goparallel.sourceforge.net/
johnk | 2 Apr 19:22 2015
Picon

Working on adding PlantUML class diagrams

I'm interested in (and have started) modifying the Doxygen code to allow 
for the generation of class diagrams using PlantUML, but I wanted to get 
some input before I got too far in.

My current thinking is just to have the diagrams generated as an aside 
to the Graphviz diagrams.  I mostly wanted a tool to automatically 
generate nice UML class diagrams from my code.  I'm already using 
Doxygen and it has a framework for doing this already. PlantUML does not 
support image mapping so the nice links that are generated in Graphviz 
simply aren't available.

That said, others probably have a different opinion on how best to 
utilize PlantUML.  As such, I'm open to suggestions as to how best to 
utilize the tool inside Doxygen (beyond the already available embedded 
diagrams).

I should probably mention that I'm only inclined to add support for 
PlantUML class diagrams - it's not really suited for the other types of 
diagrams that Doxygen generates.

------------------------------------------------------------------------------
Dive into the World of Parallel Programming The Go Parallel Website, sponsored
by Intel and developed in partnership with Slashdot Media, is your hub for all
things parallel software development, from weekly thought leadership blogs to
news, videos, case studies, tutorials and more. Take a look and join the 
conversation now. http://goparallel.sourceforge.net/
Travis Everett | 29 Mar 18:50 2015
Picon

sqlite implementation

Hi all,

I was excited to see the sqlite generator addition back in 1.8.4, as I was struggling with the clunkiness of trying to integrate the in-game developer documentation system for a MUD I admin for with doxygen's XML output. Unfortunately when I took a look at what was being stored in sqlite, it wasn't a step up from what we could get by parsing the xml, so I put the project on hold to see if better support would turn up. It seems like progress on the implementation has been languishing for the past year, so I've been taking a more serious look at what information's being stored, and how much work it'll take to push the existing implementation forward to fit our use case (a slow process, since I haven't worked on doxygen before, or even written any C++ in the last ~12 years...)

At first I thought this might just be a matter of extending support for groups and pages, but as I've been getting my hands dirty I've found a number of issues that suggest that the current implementation probably isn't using an ideal schema or data model. For example, because we have a lot of inheritance relationships documented, our memberdef table has 87100 total records, 70545 of which are duplicates of 3197 unique members that differ only in rowid. I'm hoping to get a sense of whether anyone here:
- already has substantive work done on issues with this implementation that hasn't worked its way upstream to the doxygen repo yet
- is actually using it for something non-trivial (and whether you're using workarounds to do so)

Just hoping to get a sense of whether I am or can avoid reinventing the wheel, and how much resistance there will be to schema changes.

Cheers,
Travis
------------------------------------------------------------------------------
Dive into the World of Parallel Programming The Go Parallel Website, sponsored
by Intel and developed in partnership with Slashdot Media, is your hub for all
things parallel software development, from weekly thought leadership blogs to
news, videos, case studies, tutorials and more. Take a look and join the 
conversation now. http://goparallel.sourceforge.net/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Stormont, Brian | 9 Mar 17:46 2015

Possible bug in writeDotImageMapFromFile()

Hi,

While using the \dot and \dotfile commands, I ran across a potential bug in writeDotImageMapFromFile() in dot.cpp.  The following is a snippet of the existing code:

  if (imgExt=="svg") // vector graphics

  {

    //writeSVGFigureLink(t,relPath,inFile,inFile+".svg");

    //DotFilePatcher patcher(inFile+".svg");

    QCString svgName=outDir+"/"+baseName+".svg";

    writeSVGFigureLink(t,relPath,baseName,svgName);

    DotFilePatcher patcher(svgName);

    patcher.addSVGConversion(relPath,TRUE,context,TRUE,graphId);

    patcher.run();

  }


Note that the SVG file link is created *before* the SVG file is patched with the svgpan.js support.   As a result, for any \dot or \dotfile that has a resulting large size, the iframe link generated by writeSVGFigureLink() will be forced to the actual dimensions of the SVG (potentially thousands of pixels wide), so the svgpan.js will not provide any useful functionality and viewing the resulting embedded SVG is unwieldy.

Moving the writeSVGFigureLink() to *after* the call to patcher.run() produces better HTML results where the embedded SVG is put in an HTML iframe with "width=100%" rather than the original SVG width, however I wasn't sure if doing so would have any adverse effects.

Thanks,
Brian 




- CONFIDENTIAL-

This email and any files transmitted with it are confidential, and may also be legally privileged. If you are not the intended recipient, you may not review, use, copy, or distribute this message. If you receive this email in error, please notify the sender immediately by reply email and then delete this email.
------------------------------------------------------------------------------
Dive into the World of Parallel Programming The Go Parallel Website, sponsored
by Intel and developed in partnership with Slashdot Media, is your hub for all
things parallel software development, from weekly thought leadership blogs to
news, videos, case studies, tutorials and more. Take a look and join the 
conversation now. http://goparallel.sourceforge.net/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Shashank Chintalagiri | 11 Feb 21:08 2015
Picon

Preprocess generated .dot files

Hello,

I've been using doxygen recently to try to document some embedded code I'm working on. I would like to be able to insert some custom processing code on the generated .dot files before they are used.

I've put up a small example of what I'd like to do up at http://static.chintal.in/doxygen/simplify.html

Is there some way to get doxygen to allow calling a script from within doxygen? I can't seem to find any related config options, but perhaps there is some plugin interface I could use or such?

Thanks
Shashank
------------------------------------------------------------------------------
Dive into the World of Parallel Programming. The Go Parallel Website,
sponsored by Intel and developed in partnership with Slashdot Media, is your
hub for all things parallel software development, from weekly thought
leadership blogs to news, videos, case studies, tutorials and more. Take a
look and join the conversation now. http://goparallel.sourceforge.net/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Eckard Klotz | 1 Feb 15:20 2015
Picon

Tutorial Message Sequence Charts with Moritz is online

Hello every body

As already announced last year, a first tutorial was published today to 
show how to create message sequence charts with Moritz. As for nassi 
shneiderman or uml like activity diagrams Moritz generates no images 
directly but image describing scripts in this case scripts for the tool 
msgen you will find at
    http://www.mcternan.me.uk/mscgen/
Mscgen is already known by Doxygen and the script-files can be added to 
the Doxygen output by using the command mscfile .
This first version is published to introduce the new feature of Moritz 
that is still under development. The goal is to ask the users to take a 
look and to post some comments in the forum at
     http://sourceforge.net/p/moritz/discussion/
A pdf in tutorial describes the basic steps needed to create message 
sequence charts. The provided folder "MessageSequence_1" contains the 
example based on the same sources as the other tutorials.

Please try it out and post a comment,
Eckard Klotz.

------------------------------------------------------------------------------
Dive into the World of Parallel Programming. The Go Parallel Website,
sponsored by Intel and developed in partnership with Slashdot Media, is your
hub for all things parallel software development, from weekly thought
leadership blogs to news, videos, case studies, tutorials and more. Take a
look and join the conversation now. http://goparallel.sourceforge.net/
Rolf Hemmerling | 24 Jan 10:51 2015

Doxygen 1.8.9 on Win8.1 "Error: Reference source not found" in refman.

Hello,

a)
with RTF output of Doxygen 1.8.9 on english Windows 8.1, there is the 
problem in the file refman.rtf

> File Index
> 	File List
> Here is a list of all documented files with brief descriptions:
> C:/Users/Public/projects_local/hemmerling/hemmerling_pwendean_keil/src/getline.c (Line
Edited Character Input for the application "Paketwendeanlage" ) 	Error: Reference source not found

while of course Doxygen was/is processing all the mentioned files, 
successfully ( as shown by the HTML output, and the logging ).

If I move the "refman.rtf" file to another *german* Windows 7, the error 
message even changes to German language "Fehler: Referenz nicht gefunden".

There is nothing special with the files, or the file location. I did not 
include special informations in the parsed files to handle the "File 
list" section.

b)
I found a description of this kind of bug here

"Don’t Let Word Get You Down, With “Error! Reference Source Not Found”
http://www.turbolaw.com/blog/2007/10/05/dont-let-word-get-you-down-with-error-reference-source-not-found/

So I would be pleased about an improved software update :-).

Sincerely
Rolf

--

-- 
http://www.hemmerling.com
SCADA Expertness - Quality Intensification for IT + Automation
Member of Texas Instruments Expert Advisory Panel
CeBIT Competence Store Partner

------------------------------------------------------------------------------
New Year. New Location. New Benefits. New Data Center in Ashburn, VA.
GigeNET is offering a free month of service with a new server in Ashburn.
Choose from 2 high performing configs, both with 100TB of bandwidth.
Higher redundancy.Lower latency.Increased capacity.Completely compliant.
http://p.sf.net/sfu/gigenet
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Rolf Hemmerling | 24 Jan 10:32 2015
Picon
Picon

Doxygen 1.8.9 on Win8.1 is "swallowing" some (expected) characters in the log

Hello,

Some output of Doxygen 1.8.9 on Win8.1 is "missing", see

**************
> Combining RTF output...
> lookup cache used 44/65536 hits=71 misses=44
> finished...
> irq.c is not documented.
--^
There is never a file "irq.c" in the directory, but just "sioirq.c".
> C:/Users/Public/projects_local/hemmerling/hemmerling_pwendean_keil/src/sioirq.c:50:
warning: Member oend (variable) of file sioirq.c is not documented.
--^
Here and everyelse, "sioirq.c" is properly displayed.
*************

This means that Doxygen at that point is "swallowing" some characters in 
the output to the log file.

Maybe it is a typical "buffer problem", as known from such legacy 
software ( 1997 was initial release according to Wikipedia ), and so 
maybe the indication of much bigger fault.

I didn´t check the Doxygen source code for the bug.
I would be pleased if you can fix it, anyhow.

** Anyhow I think Doxygen is really-great software, thanks for 
development + free license **

Sincerely
Rolf

Complete output of Doxygen:
************************************
C:/Users/Public/projects_local/hemmerling/hemmerling_pwendean_keil/src/sioirq.c:37: 
warning: Member S0BUF (macro definition) of file sioirq.c is not documented.
C:/Users/Public/projects_local/hemmerling/hemmerling_pwendean_keil/src/sioirq.c:38: 
warning: Member RI0 (macro definition) of file sioirq.c is not documented.

...

finalizing index lists...
writing tag file...
Combining RTF output...
lookup cache used 44/65536 hits=71 misses=44
finished...
irq.c is not documented.
C:/Users/Public/projects_local/hemmerling/hemmerling_pwendean_keil/src/sioirq.c:50: 
warning: Member oend (variable) of file sioirq.c is not documented.
...
*** Doxygen has finished
************************************
--

-- 
http://www.hemmerling.com
SCADA Expertness - Quality Intensification for IT + Automation
Member of Texas Instruments Expert Advisory Panel
CeBIT Competence Store Partner

------------------------------------------------------------------------------
New Year. New Location. New Benefits. New Data Center in Ashburn, VA.
GigeNET is offering a free month of service with a new server in Ashburn.
Choose from 2 high performing configs, both with 100TB of bandwidth.
Higher redundancy.Lower latency.Increased capacity.Completely compliant.
http://p.sf.net/sfu/gigenet
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop

Gmane