AMSTryst5iVe | 27 Jun 19:18 2014
Picon

Finding of no documentation ( <at> nodoc) API usage

Hi, is it possible to set a property/flag about a class or method (in c++)
that is  <at> nodoc, and then having a css class on the generated html, so that
you style it differently?  We code for a major CAD application that some of
the API are risky to use.  They come with no documentation and can be remove
without notice.  For each of our applications we would want to document the
usages of these API.  In the CAD development .h files each occurrence of
 <at> nodoc identifies the class or method that is marked as no documentation
(This depicts an Internal Resource. Its usage is prohibited.).

*Example:*
/**
 *  <at> nodoc
 */
   CATNotification * GetRadBModifyNotification() const;

Thanks!

--
View this message in context: http://doxygen.10944.n7.nabble.com/Finding-of-no-documentation-nodoc-API-usage-tp6699.html
Sent from the Doxygen - Development mailing list archive at Nabble.com.

------------------------------------------------------------------------------
Open source business process management suite built on Java and Eclipse
Turn processes into business applications with Bonita BPM Community Edition
Quickly connect people, data, and systems into organized workflows
Winner of BOSSIE, CODIE, OW2 and Gartner awards
http://p.sf.net/sfu/Bonitasoft
Fredrik Orderud | 9 Jun 23:49 2014
Picon

[dot] Inconsistent default margins for png vs. pdf

There seem to be an issue with inconsistent default margins when using dot to generate "png" vs. "pdf" output. The "png" target appears to have narrow margins as default (margin=0), where as the "pdf" target has significantly larger default margins. I'm using Doxygen 1.8.7 and Graphviz 2.38 on Windows 7.

The wide pdf margins are causing problems with figures taking up unnecessary much space when using doxygen with dot to generate latex/pdf documentation.

Could it be possible modify Doxygen to either add a "margin=0;" line to all generated dot-files, or to provide a "-Fmargin=0" command-line argument to dot, so that pdf figures becomes as compact as png figures?

Thanks in advance,
Fredrik Orderud

------------------------------------------------------------------------------
HPCC Systems Open Source Big Data Platform from LexisNexis Risk Solutions
Find What Matters Most in Your Big Data with HPCC Systems
Open Source. Fast. Scalable. Simple. Ideal for Dirty Data.
Leverages Graph Analysis for Fast Processing & Easy Data Exploration
http://p.sf.net/sfu/hpccsystems
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Dawson, Mark | 9 Jun 22:48 2014

Displaying hyperlinks in Doxygen HTML content

I have been using Doxygen to generate HTML reference content, based on comment text drawn from comments in C# header files.

 

I have been including a hyperlink to a PDF document in many of these comments, drawn from a public web site. The text I include with the comment describing the PDF document appears fine, but the HTML files that Doxygen generates never show the associated hyperlink.  The HREF reference statement is simply ignored.

 

Any ideas why this is happening?

 

I am using Doxygen version 1.5.2. Is that the problem?

------------------------------------------------------------------------------
HPCC Systems Open Source Big Data Platform from LexisNexis Risk Solutions
Find What Matters Most in Your Big Data with HPCC Systems
Open Source. Fast. Scalable. Simple. Ideal for Dirty Data.
Leverages Graph Analysis for Fast Processing & Easy Data Exploration
http://p.sf.net/sfu/hpccsystems
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Mikhail Matrosov | 2 Jun 12:59 2014
Picon

Class dependency graph with doxygen

Here is the sample code:

class Used {
public:
  void bar();
};

class Base { };

class Derived : public Base {
public:
  void foo(Used*);  // Dependency on class Used
};

Here is the collaboration diagram generated by doxygen:

Nice, but Derived depends on Used through the method foo, and I want to see this on the diagram, like this:


Unfortunately, doxygen generates such dependency only if Used is aggregated with Derived (used as a class member). Is there a way to show other kinds of dependencies between classes?

-----
Best regards, Mikhail Matrosov
------------------------------------------------------------------------------
Learn Graph Databases - Download FREE O'Reilly Book
"Graph Databases" is the definitive new guide to graph databases and their 
applications. Written by three acclaimed leaders in the field, 
this first edition is now available. Download your free book today!
http://p.sf.net/sfu/NeoTech
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Jitesh.Butala | 28 May 13:51 2014

[Doxygen] [Tag Files] Latex documentation

Hello All,

I am trying to build the documentation in the Latex format. For this, I have multiple modules out of which only a few would change at a time. Hence, I was exploring the possibility of using the Tag files to generate and keep the documentation of all the modules and build only the changed modules before combining all the documentation together. In this, I can generate the tag files for each module, but am having issues when I am trying to combine the documentation for all the modules together. The code structure is -

base folder
        --> mod_1
                --> src
                --> include
                --> docs
        --> mod_2
                --> src
                --> include
                --> docs
        ....
        --> mod_n
                --> src
                --> include
                --> docs

The docs folder contains the tag files and the latex directory with the documentation. Hence, in my top level target, I set the following variables -
TAGFILES =         ../mod_1/docs/mod_1.tag=../mod_1/docs/latex \
                ../mod_2/docs/mod_2.tag=../mod_2/docs/latex \
                ......
                ../mod_n/docs/mod_n.tag=../mod_n/docs/latex

When I run doxygen, I do not see the documentation of the modules either embedded or a link to it in the main document. Please could you help me in figuring out what is the issue. One thing which I see is that whenever tag files are mentioned, I see only HTML type of documentation, but find no explicit (at least in the documents that I have seen) mention of tag files working only with HTML.

Thanks,
Jitesh Butala
Team Lead (Applications) - Sr. Design Engineer
ifm engineering pvt. ltd.  
www.ifm.com
CIN No. U29213PN2010FTC136766
------------------------------------------------------------------------------
Time is money. Stop wasting it! Get your web API in 5 minutes.
www.restlet.com/download
http://p.sf.net/sfu/restlet
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Roland Vossen | 28 Apr 10:14 2014

Tcl parsing problem

Hello Albert,

When parsing a certain Tcl file, I noted that the majority of Tcl procs did not show up in Doxygens html
output. I did some experiments and could drill it down to the following:

<some_file.tcl>
proc foo {} {
#	if { ($classifier_state == {{bphy} } ) } { OK
	if { ($classifier_state == {{bphy} }) } { ;# NOK
		puts "this proc is always shown in html output"
	}
}

proc bar {} {
	puts "this proc is not shown in html output in NOK case"
}

Note the subtle difference between the two 'if' statements: there is an extra space character between a '}'
and the ')'.

Is this something you can look at ?

Thanks, Roland.

------------------------------------------------------------------------------
"Accelerate Dev Cycles with Automated Cross-Browser Testing - For FREE
Instantly run your Selenium tests across 300+ browser/OS combos.  Get 
unparalleled scalability from the best Selenium testing platform available.
Simple to use. Nothing to install. Get started now for free."
http://p.sf.net/sfu/SauceLabs
Marcin Komorowski | 17 Apr 15:08 2014
Picon

Doxygen development/debug IDE under OSX

Hi All,

Does anyone on this list do any development/debugging of Doxygen under OSX?

Do you have any suggestion for best IDE to use under OSX for this work?

If you have one, would you be willing to share your IDE project setup file for Doxygen?

Thank You,
Marcin Komorowski

------------------------------------------------------------------------------
Learn Graph Databases - Download FREE O'Reilly Book
"Graph Databases" is the definitive new guide to graph databases and their
applications. Written by three acclaimed leaders in the field,
this first edition is now available. Download your free book today!
http://p.sf.net/sfu/NeoTech
Markus Geimer | 12 Apr 18:49 2014
Picon

Double dash within <tt> or <code> is again (or still?) broken

Hi,

This issue has already been reported ten years ago in bugreport
https://bugzilla.gnome.org/show_bug.cgi?id=133418 and was marked
as resolved, however, I see this issue again/still with current
sources from git (just sync'ed my local copy).

Simply try something like
	<tt>--prefix</tt>
or
	<code>--prefix</code>
and you will get '&ndash;' in the HTML output and '--' in LaTeX
(should be '-\/-' to prevent getting the en-dash). Same applies
to the em-dash, though I assume that this is used less often in
<tt>/<code> environments.

On the other hand, the LaTeX output contains an unnecessary italic
correction for dashes between words. For example, 'so-called' is
typeset as 'so-\/called'.

Unfortunately, I couldn't yet figure out where things go wrong.
The output of '-d commentscan' already reports '--' or '&ndash;'
depending on the MARKDOWN_SUPPORT setting, however, the final
output is identical in both cases. Some hint where to start would
be very welcome.

Thanks,
Markus

------------------------------------------------------------------------------
Put Bad Developers to Shame
Dominate Development with Jenkins Continuous Integration
Continuously Automate Build, Test & Deployment 
Start a new project now. Try Jenkins in the cloud.
http://p.sf.net/sfu/13600_Cloudbees
Markus Geimer | 9 Apr 19:34 2014
Picon

[PATCH] Fix broken links to subpages in LaTeX output

Hi,

The attached patch fixes a bug in generating references to subpages (and
potentially also other items) in the LaTeX output when PDF_HYPERLINKS is
set to NO. I also included a minimal example.

Cheers,
Markus
Attachment (example.tgz): application/x-gtar-compressed, 166 bytes
------------------------------------------------------------------------------
Put Bad Developers to Shame
Dominate Development with Jenkins Continuous Integration
Continuously Automate Build, Test & Deployment 
Start a new project now. Try Jenkins in the cloud.
http://p.sf.net/sfu/13600_Cloudbees
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Phil Mason | 9 Apr 16:07 2014

Some meta tags are not properly closed.

Hi,

 

When I run doxygen built from git head on some of my source the resulting html has meta tags that are not properly closed (and fail to pass the w3c validator as a result). The following is a sample of the html output (from html/search/all_0.html):

 

<html><head><title></title>

<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

<meta name="generator" content="Doxygen 1.8.6">

 

Note that the second meta tag is not properly closed (and as the doctype of this file is XHTML it needs to be).

 

This trivial patch resolves this issue:

 

diff --git a/src/searchindex.cpp b/src/searchindex.cpp

index 7aa8216..a550eb1 100644

--- a/src/searchindex.cpp

+++ b/src/searchindex.cpp

<at> <at> -1027,7 +1027,7 <at> <at> void writeJavascriptSearchIndex()

             " \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">" << endl;

           t << "<html><head><title></title>" << endl;

           t << "<meta http-equiv=\"Content-Type\" content=\"text/xhtml;charset=UTF-8\"/>" << endl;

-          t << "<meta name=\"generator\" content=\"Doxygen " << versionString << "\">" << endl;

+          t << "<meta name=\"generator\" content=\"Doxygen " << versionString << "\"/>" << endl;

           t << "<link rel=\"stylesheet\" type=\"text/css\" href=\"search.css\"/>" << endl;

           t << "<script type=\"text/javascript\" src=\"" << baseName << ".js\"></script>" << endl;

           t << "<script type=\"text/javascript\" src=\"search.js\"></script>" << endl;

 

Hope this is useful

 

Regards

 

Phil

 

------------------------------------------------------------------------------
Put Bad Developers to Shame
Dominate Development with Jenkins Continuous Integration
Continuously Automate Build, Test & Deployment 
Start a new project now. Try Jenkins in the cloud.
http://p.sf.net/sfu/13600_Cloudbees
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Ross Rogers | 19 Dec 20:38 2013
Picon

Re 3321410 - was ditaa ever integrated?

Hello,

Regarding the ancient thread http://sourceforge.net/mailarchive/message.php?msg_id=3321410 , was ditaa ever integrated into doxygen or is there a generalized mechanism for doing external text->image processing?

 - Ross
------------------------------------------------------------------------------
Rapidly troubleshoot problems before they affect your business. Most IT 
organizations don't have a clear picture of how application performance 
affects their revenue. With AppDynamics, you get 100% visibility into your 
Java,.NET, & PHP application. Start your 15-day FREE TRIAL of AppDynamics Pro!
http://pubads.g.doubleclick.net/gampad/clk?id=84349831&iu=/4140/ostg.clktrk
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop