Hans Z | 5 Oct 19:39 2014
Picon

Config: Special Commands Indicator

Hello,

Is it possible either in the current release or possibly in a future
release, to configure what the special commands indicator?  Very often
documentation contains at-signs or backslashes and while I know of the
workarounds to escape them, in some cases this becomes very tedious.

Would it be possible to add a configuration directive that allows
setting what the special commands indicator would be?  For example:

SPECIAL_CMD_INDICATOR =  <at>  <at> 

Thank you,

---
Hans Zaunere / Managing Member / Stackware, LLC
              stackware.com   /   cnvyr.io

------------------------------------------------------------------------------
Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
Moreno | 4 Sep 17:33 2014
Picon

Java pre and code tags are ignored

Hi all,
there is a way to produce a code snippet without losing indented code in Eclipse?

We tried to use <pre><code> tag but these are ignored.
Using the spacing or the ~ in a row seems to work, but the help showed by Eclipse is basically unreadable.

Has anyone had the same problem?

Thank you

--
Moreno
------------------------------------------------------------------------------
Slashdot TV.  
Video for Nerds.  Stuff that matters.
http://tv.slashdot.org/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Moreno | 4 Sep 17:33 2014
Picon

Possible bug while producing documentation of java method which uses generics

Hi all,
we are trying to produce Doxygen documentation from Javadoc placed in code.
We noticed that Doxygen 1.8.8 has fixed a similar bug about Java generics used by a class (http://github.com/doxygen/doxygen/commit/c3ddf3331239fb3f41e502a8337eee786ceaad06), but we are facing with a method that uses generics:

...

/**
* This is a brief comment.
* <at> param handler your handler implementation
*/
public <E extends BaseEvent, L extends BaseListener<E>> void addHandler(BaseHandler<E, L> handler) {
// do something
}
 
...


Seems that Doxygen completely ignores the code annotations from that method to the end of same class.
The log doesn't say anything about that and the method is not reported on the produced html.

Has anyone had the same problem?

Thank you

--
Moreno
------------------------------------------------------------------------------
Slashdot TV.  
Video for Nerds.  Stuff that matters.
http://tv.slashdot.org/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Vadim Zeitlin | 12 Aug 15:31 2014

Language-specific tags

 Hello,

 I'm working on generating documentation for the languages other than C++
from Doxygen comments in C++ code using SWIG (http://www.swig.org/). This
works by taking comments in C++ sources, optionally translating them to the
target language format (JavaDoc, reST/Sphinx, ...) and attaching them to
the classes/functions wrapping their C++ equivalents. Finally, either
Doxygen itself (if no translation has been done) or javadoc/sphinx (if the
comments were translated) can be used to produce the documentation for the
API in the other language.

 Perhaps surprisingly, this process seems to work rather well and such
auto-translated documentation is genuinely useful. However, there still are
some problems, notably some C++ comments don't make any sense in the target
language context and have to be fixed manually.

 The only way to do it I see is to add special Doxygen commands allowing to
indicate that some parts of the comments are for C++ documentation only.
And probably also, if only for symmetry, other commands that would on the
contrary only output something when generating documentation for the other
language and not C++, e.g.

	/**
		Some comment.

		General description.

		 <at> forcpponly
		C++-specific part.
		 <at> endforcpponly

		 <at> forpythononly
		Python-specific part.
		 <at> endforpythononly
	*/

 Nothing is required to support this at Doxygen level as these commands
could just be defined as aliases using  <at> if to determine whether they should
output something or not. But I'd like to ask if anybody here has already
done anything like this, even if manually, without involving SWIG, and
maybe has some hints to share?

 And, also, just to avoid or at least reduce the risk of conflict with some
standard Doxygen command in the future, what should we call these commands?
I initially wanted to use just  <at> pythononly/ <at> endpythononly, for consistency
with the existing  <at> docbookonly and such, but then decided that it would be
better to use something similar, but different, to emphasize that Python is
a programming language and not an output format. Would you have any advice
about this?

 TIA for any thoughts!
VZ
------------------------------------------------------------------------------
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Andreas Tscharner | 11 Aug 12:53 2014
Picon

\deprecated and \todo in \enum description not in corresponding todo/deprecated list

Hello World,

If I have a \deprecated or \todo in an \enum description (in a IDL 
file), these entries do not show up in the deprecated or todo list. 
\deprecated und \todo entries in method or interface descriptions are 
listed. The actual description of \enum is correct (\todo and 
\deprecated are shown).

Example:

   /** \enum MyEnum
     * \brief Brief description of my enum
     *
     * Longer description of my enum
     *
     * \todo A TODO for my enum which does not show up
     *
     *
     * \typedef MyEnum TheEnum
     *
     * Rename enumeration to a better name
     */
   [ uuid(9CAF43A5-75A0-42E5-B43C-D0BF92C3A773), version(1.0) ]
   typedef enum MyEnum
   {
     FirstEnum = 0x0001, //!< Description of first enum
     ...
     ...
     LastEnum = 0xFFFF  //<! Description of last enum
   } TheEnum;

The \todo does not show up in the list. It shows up, if it is moved 
below \typdef (but of course, it is then a TODO for the typedef, not the 
enum)

I noticed the exact same behavior for \deprecated.

Platform:
Windows 7 Professional, SP1, all patches applied (Microsoft Windows 
[Version 6.1.7601])
doxygen Version 1.8.7

Is this intended behavior or a bug?

Best regards
	Andreas
--

-- 
       ("`-''-/").___..--''"`-._
        `o_ o  )   `-.  (     ).`-.__.`)
        (_Y_.)'  ._   )  `._ `. ``-..-'
      _..`--'_..-_/  /--'_.' .'
     (il).-''  (li).'  ((!.-'

Andreas Tscharner   andy <at> vis.ethz.ch   ICQ-No. 14356454

------------------------------------------------------------------------------
Chris Krycho | 24 Jul 14:17 2014

OS X doxywizard build

 
I’m running Doxygen on OS X, and am interested in updating the Qt build so
that the various GUI tools (which are super handy) render correctly on "retina"
devices on OS X. This should be pretty straightforward -- it's just a tweak to
the `.plist` file. I can probably do it in a weekend. Before I jump in, though,
I wanted to make sure I was heading the right direction, so a few questions:

 1. At present, it looks like you’re using the unmodified Qt settings to
    generate all the OS X files -- i.e. you are *not* supplying them via the
    `QMAKE_INFO_PLIST` build variable. Is that correct?
 2. It appears all the relevant source for the GUI tools are in the `addon`
    directory -- is that correct?
 3. Building the Qt components failed with clang on OS X. I have standard GCC
    as well, so this isn’t a problem for me but I wanted to check that you
    knew this to be the case and see if you’re interested in getting clang
    build support.

Finally, I assume I should just send a pull request on GitHub with the changes
when I’m done?

Regards,
Chris Krycho

------------------------------------------------------------------------------
Want fast and easy access to all the code in your enterprise? Index and
search up to 200,000 lines of code with a free copy of Black Duck
Code Sight - the same software that powers the world's largest code
search on Ohloh, the Black Duck Open Hub! Try it now.
http://p.sf.net/sfu/bds
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
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