doxygen-users — List for users of doxygen

Re: [Doxygen-users] Problem with Objective-C

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

Hi Christian,

That is wrong indeed. I've pushed a fix to GitHub:
https://github.com/doxygen/doxygen/commit/09a5fc198a98d697d3e50c1c76392b8373f1af12

Regards,
  Dimitri

On 11 Jan 2014, at 19:17 , Christian Holzberger <ch...@mo...> wrote:

> Hi,
> 
> i cant get the following snippet to be parsed correctly when i add a newline in between. 
> 
> This parses correctly and shows the right "inherited“  protocols 
> [code]
> //
> //  FormEditorViewController.h
> //  Formulare
> //
> //  Created by vadmin on 10.11.13.
> //  Copyright (c) 2013 vadmin. All rights reserved.
> //
> #import <UIKit/UIKit.h>
> #import "Form.h"
> #import "FormField.h"
> #import "FormGroup.h"
> #import "FilledForm.h"
> #import "FilledFormField.h"
> #import "FormFieldComboValue.h"
> #import "FilledForm+FilledFormAdditions.h"
> #import "ComboViewController.h"
> 
> /**
>  * Main Editor Component, used to fill-in forms
>  **/
> @interface FormEditorViewController : UITableViewController <UITableViewDataSource, UITableViewDelegate, NSFetchedResultsControllerDelegate>
> 
> /**
>  * Titel dieser View
>  */
> @property NSString *titel;
> @property (weak, nonatomic) IBOutlet UINavigationItem *nav;
> @property (strong, nonatomic) NSFetchedResultsController *fetchedResultsController;
> @property (strong, nonatomic) NSManagedObjectContext *managedObjectContext;
> 
> - (IBAction)save:(id)sender;
> - (void)loadForm:(NSManagedObjectID *)forId;
> - (void)createForm:(Form *)preset;
> - (void) dateClick:(id)sender;
> - (void) comboClick:(id)sender;
> @end
> [/code]
> 
> but this wont:
> 
> [code]
> //
> //  FormEditorViewController.h
> //  Formulare
> //
> //  Created by vadmin on 10.11.13.
> //  Copyright (c) 2013 vadmin. All rights reserved.
> //
> #import <UIKit/UIKit.h>
> #import "Form.h"
> #import "FormField.h"
> #import "FormGroup.h"
> #import "FilledForm.h"
> #import "FilledFormField.h"
> #import "FormFieldComboValue.h"
> #import "FilledForm+FilledFormAdditions.h"
> #import "ComboViewController.h"
> 
> /**
>  * Main Editor Component, used to fill-in forms
>  **/
> @interface FormEditorViewController : UITableViewController 
> <UITableViewDataSource, UITableViewDelegate, NSFetchedResultsControllerDelegate>
> 
> /**
>  * Titel dieser View
>  */
> @property NSString *titel;
> @property (weak, nonatomic) IBOutlet UINavigationItem *nav;
> @property (strong, nonatomic) NSFetchedResultsController *fetchedResultsController;
> @property (strong, nonatomic) NSManagedObjectContext *managedObjectContext;
> 
> - (IBAction)save:(id)sender;
> - (void)loadForm:(NSManagedObjectID *)forId;
> - (void)createForm:(Form *)preset;
> - (void) dateClick:(id)sender;
> - (void) comboClick:(id)sender;
> @end
> [/code]
> 
> can provide doxywizard configuration if it matters. i’m using doxygen 1.8.6.
> 
> thanks for any help.
> 
> Christian Holzberger
> 
> 
> 
> 
> 
> ------------------------------------------------------------------------------
> CenturyLink Cloud: The Leader in Enterprise Cloud Services.
> Learn Why More Businesses Are Choosing CenturyLink Cloud For
> Critical Workloads, Development Environments & Everything In Between.
> Get a Quote or Start a Free Trial Today. 
> http://pubads.g.doubleclick.net/gampad/clk?id=119420431&iu=/4140/ostg.clktrk_______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Problem with Objective-C

[Christian H. <ch...@mo...>]

Hi,

i cant get the following snippet to be parsed correctly when i add a newline in between. 

This parses correctly and shows the right "inherited“  protocols 
[code]
//
//  FormEditorViewController.h
//  Formulare
//
//  Created by vadmin on 10.11.13.
//  Copyright (c) 2013 vadmin. All rights reserved.
//
#import <UIKit/UIKit.h>
#import "Form.h"
#import "FormField.h"
#import "FormGroup.h"
#import "FilledForm.h"
#import "FilledFormField.h"
#import "FormFieldComboValue.h"
#import "FilledForm+FilledFormAdditions.h"
#import "ComboViewController.h"

/**
 * Main Editor Component, used to fill-in forms
 **/
@interface FormEditorViewController : UITableViewController <UITableViewDataSource, UITableViewDelegate, NSFetchedResultsControllerDelegate>

/**
 * Titel dieser View
 */
@property NSString *titel;
@property (weak, nonatomic) IBOutlet UINavigationItem *nav;
@property (strong, nonatomic) NSFetchedResultsController *fetchedResultsController;
@property (strong, nonatomic) NSManagedObjectContext *managedObjectContext;

- (IBAction)save:(id)sender;
- (void)loadForm:(NSManagedObjectID *)forId;
- (void)createForm:(Form *)preset;
- (void) dateClick:(id)sender;
- (void) comboClick:(id)sender;
@end
[/code]

but this wont:

[code]
//
//  FormEditorViewController.h
//  Formulare
//
//  Created by vadmin on 10.11.13.
//  Copyright (c) 2013 vadmin. All rights reserved.
//
#import <UIKit/UIKit.h>
#import "Form.h"
#import "FormField.h"
#import "FormGroup.h"
#import "FilledForm.h"
#import "FilledFormField.h"
#import "FormFieldComboValue.h"
#import "FilledForm+FilledFormAdditions.h"
#import "ComboViewController.h"

/**
 * Main Editor Component, used to fill-in forms
 **/
@interface FormEditorViewController : UITableViewController 
<UITableViewDataSource, UITableViewDelegate, NSFetchedResultsControllerDelegate>

/**
 * Titel dieser View
 */
@property NSString *titel;
@property (weak, nonatomic) IBOutlet UINavigationItem *nav;
@property (strong, nonatomic) NSFetchedResultsController *fetchedResultsController;
@property (strong, nonatomic) NSManagedObjectContext *managedObjectContext;

- (IBAction)save:(id)sender;
- (void)loadForm:(NSManagedObjectID *)forId;
- (void)createForm:(Form *)preset;
- (void) dateClick:(id)sender;
- (void) comboClick:(id)sender;
@end
[/code]

can provide doxywizard configuration if it matters. i’m using doxygen 1.8.6.

thanks for any help.

Christian Holzberger

Re: [Doxygen-users] How to generate a PDF with numbered bookmark pane

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

On 10 Jan 2014, at 9:14 , Stefan Heiss <hei...@ho...> wrote:

> I found a solution to my below Problem.
> Putting the following line into the refman.tex file will provide numbered Bookmarks.
>  
> \hypersetup{bookmarksnumbered=true}
>  
> Having numbered Bookmarks, makes the Navigation in a PDF document much easier.

Ok, I'll include it in the default refman.tex.

Regards,
  Dimitri

Re: [Doxygen-users] How to generate an Appendix page

[Ron W. <ron...@gm...>]

On Fri, Jan 10, 2014 at 3:14 AM, <
dox...@li...> wrote:

> Date: Fri, 10 Jan 2014 09:08:44 +0100
> From: Stefan Heiss <hei...@ho...>
> Subject: [Doxygen-users] How to generate an Appendix page
> To: "dox...@li..."
>         <dox...@li...>
> Message-ID: <COL...@ph...l>
> Content-Type: text/plain; charset="iso-8859-1"
>
> Is there an official way to generate an doxygen page and move it in the
> Appendix. I'm currently thinking about patching the refman.tex Output from
> doxygen in such a way that it will include an Appendix, and move some pages
> therein. Basically, that works with a few awk/grep/sed lines of code.
> However, it will just be a proprietary solution, and furthermore, just for
> LATEX.
>
> However, I would Need it also for HTML Output, where I have no Idee how to
> do it there, yet. And, moreover, it has the further disadvantage, that with
> new doxygen Versions this Approach may Need to be adjusted over and over
> again.
>
> So, I would like to know how other doxygen users are coming around this
> shortage?
>
> Additionally, I would like to suggest a new doxygen command:
> @appendixpage
> which basically works similar to the @page command. However, the generated
> page will be put into an Appendix instead of the normal page place.
>

 I think you could do what you want by creating a custom "DoxygenLayout.xml".
See the "Customizing the Output" section of the doxygen documentation.

I think adding the following might do what you want:

     <tab type="user" url="@ref appendix" title="Appendix"/>

Then create a "@page appendix Appendix" page and use "@subpage" inside that
to organize your appendix pages.

[Doxygen-users] Formatting inside section title?

[Brian H. <bhe...@pi...>]

Hello,

Sorry for what may be a silly question, but is it possible to apply
formatting inside a section title?  Some of my section titles include code
fragments (method names, etc) and I'd like them to be formatted as
monospace.  I've tried using \c special command and <code> HTML, but both
simply appear as part of the rendered text.

Example:

\section static_members \c static \c const members

Ideally, "static const" would be rendered in monospace in the final HTML.

Thanks,
~Brian

------------------------------------------------------ 
          Brian Henning, Software Engineer

    /\    Pine Research Instrumentation 
   //\\   2741 Campus Walk Ave, Bldg 100 
  ///\\\  Durham, NC 27705 
 ////\\\\ USA 
    || 
    ||    phone: 919.782.8320 
          fax:   919.782.8323 
          email: bhe...@pi... 
------------------------------------------------------ 

Re: [Doxygen-users] How to generate a PDF with numbered bookmark pane

[Stefan H. <hei...@ho...>]

I found a solution to my below Problem.
Putting the following line into the refman.tex file will provide numbered Bookmarks.
 
\hypersetup{bookmarksnumbered=true}
 
Having numbered Bookmarks, makes the Navigation in a PDF document much easier.
 
From: hei...@ho...
To: dox...@li...
Date: Wed, 8 Jan 2014 11:07:30 +0100
Subject: [Doxygen-users] How to generate a PDF with numbered bookmark pane







I generate a PDF out of doxygen's latex output using Miktex compiler. 
While the the document itself contains alphanumeric numbered headlines, 
the corresponding bookmark pane in the PDF file does only contain the 
text of the headlines, but not the numbering. Has someone a solution on 
how to get the bookmark pane also come up with numbered headlines?

Many thanks.
 		 	   		  

------------------------------------------------------------------------------
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-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users 		 	   		  

[Doxygen-users] How to generate an Appendix page

[Stefan H. <hei...@ho...>]

Is there an official way to generate an doxygen page and move it in the Appendix. I'm currently thinking about patching the refman.tex Output from doxygen in such a way that it will include an Appendix, and move some pages therein. Basically, that works with a few awk/grep/sed lines of code. However, it will just be a proprietary solution, and furthermore, just for LATEX.
 
However, I would Need it also for HTML Output, where I have no Idee how to do it there, yet. And, moreover, it has the further disadvantage, that with new doxygen Versions this Approach may Need to be adjusted over and over again.
 
So, I would like to know how other doxygen users are coming around this shortage?
 
Additionally, I would like to suggest a new doxygen command:
@appendixpage
which basically works similar to the @page command. However, the generated page will be put into an Appendix instead of the normal page place.
 
Kind Regards
Stefan
 		 	   		  

Re: [Doxygen-users] Strange "ttc"-class-div artifacts on source file pages

[Matthias T. <mat...@ru...>]

Thank you Dimitri, this was spot on!

Albert, also thank you for your reply! However,
an update didn't fix it for me, so I went with
Dimitri's SOURCE_TOOLTIPS approach.

Best,
Matthias



On 01/09/2014 10:15 PM, Dimitri van Heesch wrote:
> Hi Matthias,
>
> the ttc divs contain the contents for the new tooltip feature.
> They should normally be hidden and only turned into a tooltip when hovering the mouse over a link.
>
> You probably see them because your stylesheet/HTML header is not the default and outdated (i.e. it misses
> the section "tooltip related style info" that is in the standard doxygen.css).
>
> Note that you can also get rid of them by setting SOURCE_TOOLTIPS to NO.
>
> Regards,
>    Dimitri
>
> On 09 Jan 2014, at 13:26 , Matthias Tuma <mat...@ru...> wrote:
>
>> Hi,
>>
>> we recently noticed "new" artifacts on the bottom of those
>> Doxygen html pages which show/reproduce our source files.
>> For example: on the bottom of this page
>>
>> http://image.diku.dk/shark/doxygen_pages/html/_c_svm_grid_search_tutorial_8cpp_source.html
>>
>>
>> there is a long list of tokens referenced that has not
>> been there a few weeks ago. Although they have some relation
>> to the source file, it does not seem to serve any purpose,
>> reads like gibberish, and I would like to exclude them from
>> the generated html, like it was the default before. So, can
>> anyone enlighten me what Doxygen option generates this list?
>> Is it a bug or feature? We could not find any change in our
>> setup which might have suddenly produced this output.
>>
>> In the raw html for the above page, all these artifacts start
>> with <div class="ttc" id="...">, and a grep for that shows
>> that the ttc class seems to be reserved for these annoying
>> artifacts. But I'd very much rather eliminate them from within
>> Doxygen than via CSS. System stats and config file are below.
>>
>> Thanks for any pointers!
>> Matthias
>>
>>
>> $ doxygen -version
>> 1.8.5
>>
>> $ uname -a
>> Linux host 3.12.1-3-ARCH #1 SMP PREEMPT Tue Nov 26 11:17:02 CET 2013
>> x86_64 GNU/Linux
>> [but also on other systems]
>>
>>
>>
>> # Doxyfile 1.8.5
>>
>> #---------------------------------------------------------------------------
>> # Project related configuration options
>> #---------------------------------------------------------------------------
>> DOXYFILE_ENCODING      = UTF-8
>> PROJECT_NAME           = Shark
>> PROJECT_NUMBER         = 3.0.0
>> PROJECT_BRIEF          =
>> PROJECT_LOGO           =
>> OUTPUT_DIRECTORY       = /path/to/sharkhome/doc/doxygen_pages
>> CREATE_SUBDIRS         = NO
>> OUTPUT_LANGUAGE        = English
>> BRIEF_MEMBER_DESC      = YES
>> REPEAT_BRIEF           = YES
>> ABBREVIATE_BRIEF       =
>> ALWAYS_DETAILED_SEC    = NO
>> INLINE_INHERITED_MEMB  = NO
>> FULL_PATH_NAMES        = YES
>> STRIP_FROM_PATH        = /path/to/sharkhome/doc/..
>> STRIP_FROM_INC_PATH    = /path/to/sharkhome/doc/../include
>> SHORT_NAMES            = NO
>> JAVADOC_AUTOBRIEF      = NO
>> QT_AUTOBRIEF           = NO
>> MULTILINE_CPP_IS_BRIEF = NO
>> INHERIT_DOCS           = YES
>> SEPARATE_MEMBER_PAGES  = NO
>> TAB_SIZE               = 4
>> ALIASES                =
>> TCL_SUBST              =
>> OPTIMIZE_OUTPUT_FOR_C  = NO
>> OPTIMIZE_OUTPUT_JAVA   = NO
>> OPTIMIZE_FOR_FORTRAN   = NO
>> OPTIMIZE_OUTPUT_VHDL   = NO
>> EXTENSION_MAPPING      =
>> MARKDOWN_SUPPORT       = YES
>> AUTOLINK_SUPPORT       = YES
>> BUILTIN_STL_SUPPORT    = YES
>> CPP_CLI_SUPPORT        = NO
>> SIP_SUPPORT            = NO
>> IDL_PROPERTY_SUPPORT   = YES
>> DISTRIBUTE_GROUP_DOC   = NO
>> SUBGROUPING            = YES
>> INLINE_GROUPED_CLASSES = NO
>> INLINE_SIMPLE_STRUCTS  = NO
>> TYPEDEF_HIDES_STRUCT   = NO
>> LOOKUP_CACHE_SIZE      = 0
>> #---------------------------------------------------------------------------
>> # Build related configuration options
>> #---------------------------------------------------------------------------
>> EXTRACT_ALL            = YES
>> EXTRACT_PRIVATE        = NO
>> EXTRACT_PACKAGE        = YES
>> EXTRACT_STATIC         = YES
>> EXTRACT_LOCAL_CLASSES  = YES
>> EXTRACT_LOCAL_METHODS  = NO
>> EXTRACT_ANON_NSPACES   = NO
>> HIDE_UNDOC_MEMBERS     = NO
>> HIDE_UNDOC_CLASSES     = NO
>> HIDE_FRIEND_COMPOUNDS  = NO
>> HIDE_IN_BODY_DOCS      = NO
>> INTERNAL_DOCS          = NO
>> CASE_SENSE_NAMES       = NO
>> HIDE_SCOPE_NAMES       = NO
>> SHOW_INCLUDE_FILES     = YES
>> FORCE_LOCAL_INCLUDES   = NO
>> INLINE_INFO            = YES
>> SORT_MEMBER_DOCS       = YES
>> SORT_BRIEF_DOCS        = NO
>> SORT_MEMBERS_CTORS_1ST = NO
>> SORT_GROUP_NAMES       = NO
>> SORT_BY_SCOPE_NAME     = NO
>> STRICT_PROTO_MATCHING  = NO
>> GENERATE_TODOLIST      = YES
>> GENERATE_TESTLIST      = YES
>> GENERATE_BUGLIST       = YES
>> GENERATE_DEPRECATEDLIST= YES
>> ENABLED_SECTIONS       =
>> MAX_INITIALIZER_LINES  = 30
>> SHOW_USED_FILES        = YES
>> SHOW_FILES             = YES
>> SHOW_NAMESPACES        = YES
>> FILE_VERSION_FILTER    = "svnversion /path/to/sharkhome/doc/.."
>> LAYOUT_FILE            =
>> CITE_BIB_FILES         =
>> #---------------------------------------------------------------------------
>> # Configuration options related to warning and progress messages
>> #---------------------------------------------------------------------------
>> QUIET                  = NO
>> WARNINGS               = YES
>> WARN_IF_UNDOCUMENTED   = YES
>> WARN_IF_DOC_ERROR      = YES
>> WARN_NO_PARAMDOC       = NO
>> WARN_FORMAT            = "$file:$line: $text"
>> WARN_LOGFILE           =
>> #---------------------------------------------------------------------------
>> # Configuration options related to the input files
>> #---------------------------------------------------------------------------
>> INPUT                  = /path/to/sharkhome/doc/../src \
>>                           /path/to/sharkhome/doc/../include \
>>                           /path/to/sharkhome/doc/../examples \
>>                           /path/to/sharkhome/doc/../examples \
>>                           /path/to/sharkhome/doc/../Test
>> INPUT_ENCODING         = UTF-8
>> FILE_PATTERNS          = *.h \
>>                           *.inl \
>>                           *.hpp \
>>                           *.cpp
>> RECURSIVE              = YES
>> EXCLUDE                =
>> EXCLUDE_SYMLINKS       = NO
>> EXCLUDE_PATTERNS       = */GLPK.cpp \
>>                           */.svn/* \
>>                           */Test/* \
>>                           *boost*
>> EXCLUDE_SYMBOLS        = boost::noncopyable \
>>                           *type*
>> EXAMPLE_PATH           = /path/to/sharkhome/doc/../examples
>> EXAMPLE_PATTERNS       = *.cpp
>> EXAMPLE_RECURSIVE      = YES
>> IMAGE_PATH             =
>> INPUT_FILTER           =
>> FILTER_PATTERNS        =
>> FILTER_SOURCE_FILES    = NO
>> FILTER_SOURCE_PATTERNS =
>> USE_MDFILE_AS_MAINPAGE =
>> #---------------------------------------------------------------------------
>> # Configuration options related to source browsing
>> #---------------------------------------------------------------------------
>> SOURCE_BROWSER         = YES
>> INLINE_SOURCES         = NO
>> STRIP_CODE_COMMENTS    = NO
>> REFERENCED_BY_RELATION = YES
>> REFERENCES_RELATION    = NO
>> REFERENCES_LINK_SOURCE = NO
>> SOURCE_TOOLTIPS        = YES
>> USE_HTAGS              = NO
>> VERBATIM_HEADERS       = YES
>> #---------------------------------------------------------------------------
>> # Configuration options related to the alphabetical class index
>> #---------------------------------------------------------------------------
>> ALPHABETICAL_INDEX     = YES
>> COLS_IN_ALPHA_INDEX    = 1
>> IGNORE_PREFIX          =
>> #---------------------------------------------------------------------------
>> # Configuration options related to the HTML output
>> #---------------------------------------------------------------------------
>> GENERATE_HTML          = YES
>> HTML_OUTPUT            = html
>> HTML_FILE_EXTENSION    = .html
>> HTML_HEADER            =
>> /path/to/sharkhome/doc/doxygen_pages/templates/header.html
>> HTML_FOOTER            =
>> /path/to/sharkhome/doc/doxygen_pages/templates/footer.html
>> HTML_STYLESHEET        =
>> HTML_EXTRA_STYLESHEET  =
>> HTML_EXTRA_FILES       =
>> HTML_COLORSTYLE_HUE    = 220
>> HTML_COLORSTYLE_SAT    = 100
>> HTML_COLORSTYLE_GAMMA  = 80
>> HTML_TIMESTAMP         = YES
>> HTML_DYNAMIC_SECTIONS  = YES
>> 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       = 12
>> FORMULA_TRANSPARENT    = YES
>> USE_MATHJAX            = YES
>> MATHJAX_FORMAT         = HTML-CSS
>> MATHJAX_RELPATH        =
>> http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
>> MATHJAX_EXTENSIONS     =
>> MATHJAX_CODEFILE       =
>> SEARCHENGINE           = NO
>> 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         = NO
>> LATEX_OUTPUT           = latex
>> LATEX_CMD_NAME         = latex
>> MAKEINDEX_CMD_NAME     = makeindex
>> COMPACT_LATEX          = NO
>> PAPER_TYPE             =
>> EXTRA_PACKAGES         = amsmath \
>>                           amsfonts
>> LATEX_HEADER           =
>> LATEX_FOOTER           =
>> LATEX_EXTRA_FILES      =
>> PDF_HYPERLINKS         = YES
>> USE_PDFLATEX           = YES
>> LATEX_BATCHMODE        = NO
>> LATEX_HIDE_INDICES     = NO
>> LATEX_SOURCE_CODE      = NO
>> LATEX_BIB_STYLE        = plain
>> #---------------------------------------------------------------------------
>> # Configuration options related to the RTF output
>> #---------------------------------------------------------------------------
>> GENERATE_RTF           = NO
>> RTF_OUTPUT             = rtf
>> COMPACT_RTF            = NO
>> RTF_HYPERLINKS         = NO
>> RTF_STYLESHEET_FILE    =
>> RTF_EXTENSIONS_FILE    =
>> #---------------------------------------------------------------------------
>> # Configuration options related to the man page output
>> #---------------------------------------------------------------------------
>> GENERATE_MAN           = NO
>> MAN_OUTPUT             = man
>> MAN_EXTENSION          = .3
>> MAN_LINKS              = NO
>> #---------------------------------------------------------------------------
>> # Configuration options related to the XML output
>> #---------------------------------------------------------------------------
>> GENERATE_XML           = NO
>> XML_OUTPUT             = xml
>> XML_SCHEMA             =
>> XML_DTD                =
>> XML_PROGRAMLISTING     = YES
>> #---------------------------------------------------------------------------
>> # Configuration options related to the DOCBOOK output
>> #---------------------------------------------------------------------------
>> GENERATE_DOCBOOK       = NO
>> DOCBOOK_OUTPUT         = docbook
>> #---------------------------------------------------------------------------
>> # Configuration options for the AutoGen Definitions output
>> #---------------------------------------------------------------------------
>> GENERATE_AUTOGEN_DEF   = NO
>> #---------------------------------------------------------------------------
>> # Configuration options related to the Perl module output
>> #---------------------------------------------------------------------------
>> GENERATE_PERLMOD       = NO
>> PERLMOD_LATEX          = NO
>> PERLMOD_PRETTY         = YES
>> PERLMOD_MAKEVAR_PREFIX =
>> #---------------------------------------------------------------------------
>> # Configuration options related to the preprocessor
>> #---------------------------------------------------------------------------
>> ENABLE_PREPROCESSING   = YES
>> MACRO_EXPANSION        = YES
>> EXPAND_ONLY_PREDEF     = YES
>> SEARCH_INCLUDES        = YES
>> INCLUDE_PATH           = /path/to/sharkhome/doc/../include
>> INCLUDE_FILE_PATTERNS  = *.h
>> PREDEFINED             = DOXYGEN_SHOULD_SKIP_THIS
>> EXPAND_AS_DEFINED      = SHARK_FEATURE_INTERFACE
>> SKIP_FUNCTION_MACROS   = YES
>> #---------------------------------------------------------------------------
>> # Configuration options related to external references
>> #---------------------------------------------------------------------------
>> TAGFILES               =
>> GENERATE_TAGFILE       =
>> /path/to/sharkhome/doc/doxygen_pages/tag_files/all.tag
>> ALLEXTERNALS           = NO
>> EXTERNAL_GROUPS        = YES
>> EXTERNAL_PAGES         = YES
>> PERL_PATH              = /usr/bin/perl
>> #---------------------------------------------------------------------------
>> # Configuration options related to the dot tool
>> #---------------------------------------------------------------------------
>> CLASS_DIAGRAMS         = YES
>> MSCGEN_PATH            =
>> HIDE_UNDOC_RELATIONS   = YES
>> HAVE_DOT               = YES
>> DOT_NUM_THREADS        = 0
>> DOT_FONTNAME           = Helvetica
>> DOT_FONTSIZE           = 10
>> DOT_FONTPATH           =
>> CLASS_GRAPH            = YES
>> COLLABORATION_GRAPH    = YES
>> GROUP_GRAPHS           = YES
>> UML_LOOK               = YES
>> 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           =
>> DOT_GRAPH_MAX_NODES    = 200
>> MAX_DOT_GRAPH_DEPTH    = 0
>> DOT_TRANSPARENT        = YES
>> DOT_MULTI_TARGETS      = NO
>> GENERATE_LEGEND        = YES
>> DOT_CLEANUP            = YES
>>
>>
>> ------------------------------------------------------------------------------
>> CenturyLink Cloud: The Leader in Enterprise Cloud Services.
>> Learn Why More Businesses Are Choosing CenturyLink Cloud For
>> Critical Workloads, Development Environments & Everything In Between.
>> Get a Quote or Start a Free Trial Today.
>> http://pubads.g.doubleclick.net/gampad/clk?id=119420431&iu=/4140/ostg.clktrk
>> _______________________________________________
>> Doxygen-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Re: [Doxygen-users] doxygen #define question

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

On 09 Jan 2014, at 5:56 , hew...@gm... wrote:

> Hi there!  I have a question regarding the doxygen preprocessor.  In some of my code (.c) modules I have a #define setup to tell the .h file for that module how to behave.  For example in the following file (driver.c) I define the constant CDR:
> 
> #define CDR
> #include "driver.h"
> 
> /**
>  @brief Initialize all CAN1 Driver variables.
>  @return none
> */
> void initialize(void)
> {
>  //! @todo Run some code here...
>  printf("%d", test_file_scope_variable);
> }
> 
> Then in the header file (driver.h), I perform certain actions based on whether CDR has been defined.  For example, the static variable test_file_scope_variable below is only declared if CDR is defined.
> 
> #ifdef CDR /* LOCAL definition */
> 
> /**
>  @var test_file_scope_variable
>   File Scope variable to Test doxigen
> */
> static u16 test_file_scope_variable;
> 
> #endif /* CDR */
> 
> All the above code works great at the compiler level but when I go to run doxygen the documentation generated never shows test_file_scope_variable since doxygen can't seem to see that CDR has been defined in the C module.  Does anyone know how to solve this?  I know that I can solve this by defining CDR using the PREDEFINED setting in the doxygen settings.  However this will define CDR for the whole project and I only want it defined only for this module and header combination.

Doxygen assumes that header files are self-contained and protected against multiple inclusion (with guards or #pragma once).
This is usually considered a good design practice. 

You header "driver.h" doesn't comply with this assumption as it requires CDR to be defined some somewhere outside the file. 
There is not really a good solution. Basically you want to document two "versions" of one header file (with and without CDR defined).
Maybe it is better to put the CDR related driver stuff in a driver_cdr.h header that is only included from driver.c?

Regards,
  Dimitri

Re: [Doxygen-users] Strange "ttc"-class-div artifacts on source file pages

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

Hi Matthias,

the ttc divs contain the contents for the new tooltip feature. 
They should normally be hidden and only turned into a tooltip when hovering the mouse over a link.

You probably see them because your stylesheet/HTML header is not the default and outdated (i.e. it misses
the section "tooltip related style info" that is in the standard doxygen.css).

Note that you can also get rid of them by setting SOURCE_TOOLTIPS to NO.

Regards,
  Dimitri

On 09 Jan 2014, at 13:26 , Matthias Tuma <mat...@ru...> wrote:

> Hi,
> 
> we recently noticed "new" artifacts on the bottom of those
> Doxygen html pages which show/reproduce our source files.
> For example: on the bottom of this page
> 
> http://image.diku.dk/shark/doxygen_pages/html/_c_svm_grid_search_tutorial_8cpp_source.html 
> 
> 
> there is a long list of tokens referenced that has not
> been there a few weeks ago. Although they have some relation
> to the source file, it does not seem to serve any purpose,
> reads like gibberish, and I would like to exclude them from
> the generated html, like it was the default before. So, can
> anyone enlighten me what Doxygen option generates this list?
> Is it a bug or feature? We could not find any change in our
> setup which might have suddenly produced this output.
> 
> In the raw html for the above page, all these artifacts start
> with <div class="ttc" id="...">, and a grep for that shows
> that the ttc class seems to be reserved for these annoying
> artifacts. But I'd very much rather eliminate them from within
> Doxygen than via CSS. System stats and config file are below.
> 
> Thanks for any pointers!
> Matthias
> 
> 
> $ doxygen -version
> 1.8.5
> 
> $ uname -a
> Linux host 3.12.1-3-ARCH #1 SMP PREEMPT Tue Nov 26 11:17:02 CET 2013 
> x86_64 GNU/Linux
> [but also on other systems]
> 
> 
> 
> # Doxyfile 1.8.5
> 
> #---------------------------------------------------------------------------
> # Project related configuration options
> #---------------------------------------------------------------------------
> DOXYFILE_ENCODING      = UTF-8
> PROJECT_NAME           = Shark
> PROJECT_NUMBER         = 3.0.0
> PROJECT_BRIEF          =
> PROJECT_LOGO           =
> OUTPUT_DIRECTORY       = /path/to/sharkhome/doc/doxygen_pages
> CREATE_SUBDIRS         = NO
> OUTPUT_LANGUAGE        = English
> BRIEF_MEMBER_DESC      = YES
> REPEAT_BRIEF           = YES
> ABBREVIATE_BRIEF       =
> ALWAYS_DETAILED_SEC    = NO
> INLINE_INHERITED_MEMB  = NO
> FULL_PATH_NAMES        = YES
> STRIP_FROM_PATH        = /path/to/sharkhome/doc/..
> STRIP_FROM_INC_PATH    = /path/to/sharkhome/doc/../include
> SHORT_NAMES            = NO
> JAVADOC_AUTOBRIEF      = NO
> QT_AUTOBRIEF           = NO
> MULTILINE_CPP_IS_BRIEF = NO
> INHERIT_DOCS           = YES
> SEPARATE_MEMBER_PAGES  = NO
> TAB_SIZE               = 4
> ALIASES                =
> TCL_SUBST              =
> OPTIMIZE_OUTPUT_FOR_C  = NO
> OPTIMIZE_OUTPUT_JAVA   = NO
> OPTIMIZE_FOR_FORTRAN   = NO
> OPTIMIZE_OUTPUT_VHDL   = NO
> EXTENSION_MAPPING      =
> MARKDOWN_SUPPORT       = YES
> AUTOLINK_SUPPORT       = YES
> BUILTIN_STL_SUPPORT    = YES
> CPP_CLI_SUPPORT        = NO
> SIP_SUPPORT            = NO
> IDL_PROPERTY_SUPPORT   = YES
> DISTRIBUTE_GROUP_DOC   = NO
> SUBGROUPING            = YES
> INLINE_GROUPED_CLASSES = NO
> INLINE_SIMPLE_STRUCTS  = NO
> TYPEDEF_HIDES_STRUCT   = NO
> LOOKUP_CACHE_SIZE      = 0
> #---------------------------------------------------------------------------
> # Build related configuration options
> #---------------------------------------------------------------------------
> EXTRACT_ALL            = YES
> EXTRACT_PRIVATE        = NO
> EXTRACT_PACKAGE        = YES
> EXTRACT_STATIC         = YES
> EXTRACT_LOCAL_CLASSES  = YES
> EXTRACT_LOCAL_METHODS  = NO
> EXTRACT_ANON_NSPACES   = NO
> HIDE_UNDOC_MEMBERS     = NO
> HIDE_UNDOC_CLASSES     = NO
> HIDE_FRIEND_COMPOUNDS  = NO
> HIDE_IN_BODY_DOCS      = NO
> INTERNAL_DOCS          = NO
> CASE_SENSE_NAMES       = NO
> HIDE_SCOPE_NAMES       = NO
> SHOW_INCLUDE_FILES     = YES
> FORCE_LOCAL_INCLUDES   = NO
> INLINE_INFO            = YES
> SORT_MEMBER_DOCS       = YES
> SORT_BRIEF_DOCS        = NO
> SORT_MEMBERS_CTORS_1ST = NO
> SORT_GROUP_NAMES       = NO
> SORT_BY_SCOPE_NAME     = NO
> STRICT_PROTO_MATCHING  = NO
> GENERATE_TODOLIST      = YES
> GENERATE_TESTLIST      = YES
> GENERATE_BUGLIST       = YES
> GENERATE_DEPRECATEDLIST= YES
> ENABLED_SECTIONS       =
> MAX_INITIALIZER_LINES  = 30
> SHOW_USED_FILES        = YES
> SHOW_FILES             = YES
> SHOW_NAMESPACES        = YES
> FILE_VERSION_FILTER    = "svnversion /path/to/sharkhome/doc/.."
> LAYOUT_FILE            =
> CITE_BIB_FILES         =
> #---------------------------------------------------------------------------
> # Configuration options related to warning and progress messages
> #---------------------------------------------------------------------------
> QUIET                  = NO
> WARNINGS               = YES
> WARN_IF_UNDOCUMENTED   = YES
> WARN_IF_DOC_ERROR      = YES
> WARN_NO_PARAMDOC       = NO
> WARN_FORMAT            = "$file:$line: $text"
> WARN_LOGFILE           =
> #---------------------------------------------------------------------------
> # Configuration options related to the input files
> #---------------------------------------------------------------------------
> INPUT                  = /path/to/sharkhome/doc/../src \
>                          /path/to/sharkhome/doc/../include \
>                          /path/to/sharkhome/doc/../examples \
>                          /path/to/sharkhome/doc/../examples \
>                          /path/to/sharkhome/doc/../Test
> INPUT_ENCODING         = UTF-8
> FILE_PATTERNS          = *.h \
>                          *.inl \
>                          *.hpp \
>                          *.cpp
> RECURSIVE              = YES
> EXCLUDE                =
> EXCLUDE_SYMLINKS       = NO
> EXCLUDE_PATTERNS       = */GLPK.cpp \
>                          */.svn/* \
>                          */Test/* \
>                          *boost*
> EXCLUDE_SYMBOLS        = boost::noncopyable \
>                          *type*
> EXAMPLE_PATH           = /path/to/sharkhome/doc/../examples
> EXAMPLE_PATTERNS       = *.cpp
> EXAMPLE_RECURSIVE      = YES
> IMAGE_PATH             =
> INPUT_FILTER           =
> FILTER_PATTERNS        =
> FILTER_SOURCE_FILES    = NO
> FILTER_SOURCE_PATTERNS =
> USE_MDFILE_AS_MAINPAGE =
> #---------------------------------------------------------------------------
> # Configuration options related to source browsing
> #---------------------------------------------------------------------------
> SOURCE_BROWSER         = YES
> INLINE_SOURCES         = NO
> STRIP_CODE_COMMENTS    = NO
> REFERENCED_BY_RELATION = YES
> REFERENCES_RELATION    = NO
> REFERENCES_LINK_SOURCE = NO
> SOURCE_TOOLTIPS        = YES
> USE_HTAGS              = NO
> VERBATIM_HEADERS       = YES
> #---------------------------------------------------------------------------
> # Configuration options related to the alphabetical class index
> #---------------------------------------------------------------------------
> ALPHABETICAL_INDEX     = YES
> COLS_IN_ALPHA_INDEX    = 1
> IGNORE_PREFIX          =
> #---------------------------------------------------------------------------
> # Configuration options related to the HTML output
> #---------------------------------------------------------------------------
> GENERATE_HTML          = YES
> HTML_OUTPUT            = html
> HTML_FILE_EXTENSION    = .html
> HTML_HEADER            = 
> /path/to/sharkhome/doc/doxygen_pages/templates/header.html
> HTML_FOOTER            = 
> /path/to/sharkhome/doc/doxygen_pages/templates/footer.html
> HTML_STYLESHEET        =
> HTML_EXTRA_STYLESHEET  =
> HTML_EXTRA_FILES       =
> HTML_COLORSTYLE_HUE    = 220
> HTML_COLORSTYLE_SAT    = 100
> HTML_COLORSTYLE_GAMMA  = 80
> HTML_TIMESTAMP         = YES
> HTML_DYNAMIC_SECTIONS  = YES
> 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       = 12
> FORMULA_TRANSPARENT    = YES
> USE_MATHJAX            = YES
> MATHJAX_FORMAT         = HTML-CSS
> MATHJAX_RELPATH        = 
> http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
> MATHJAX_EXTENSIONS     =
> MATHJAX_CODEFILE       =
> SEARCHENGINE           = NO
> 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         = NO
> LATEX_OUTPUT           = latex
> LATEX_CMD_NAME         = latex
> MAKEINDEX_CMD_NAME     = makeindex
> COMPACT_LATEX          = NO
> PAPER_TYPE             =
> EXTRA_PACKAGES         = amsmath \
>                          amsfonts
> LATEX_HEADER           =
> LATEX_FOOTER           =
> LATEX_EXTRA_FILES      =
> PDF_HYPERLINKS         = YES
> USE_PDFLATEX           = YES
> LATEX_BATCHMODE        = NO
> LATEX_HIDE_INDICES     = NO
> LATEX_SOURCE_CODE      = NO
> LATEX_BIB_STYLE        = plain
> #---------------------------------------------------------------------------
> # Configuration options related to the RTF output
> #---------------------------------------------------------------------------
> GENERATE_RTF           = NO
> RTF_OUTPUT             = rtf
> COMPACT_RTF            = NO
> RTF_HYPERLINKS         = NO
> RTF_STYLESHEET_FILE    =
> RTF_EXTENSIONS_FILE    =
> #---------------------------------------------------------------------------
> # Configuration options related to the man page output
> #---------------------------------------------------------------------------
> GENERATE_MAN           = NO
> MAN_OUTPUT             = man
> MAN_EXTENSION          = .3
> MAN_LINKS              = NO
> #---------------------------------------------------------------------------
> # Configuration options related to the XML output
> #---------------------------------------------------------------------------
> GENERATE_XML           = NO
> XML_OUTPUT             = xml
> XML_SCHEMA             =
> XML_DTD                =
> XML_PROGRAMLISTING     = YES
> #---------------------------------------------------------------------------
> # Configuration options related to the DOCBOOK output
> #---------------------------------------------------------------------------
> GENERATE_DOCBOOK       = NO
> DOCBOOK_OUTPUT         = docbook
> #---------------------------------------------------------------------------
> # Configuration options for the AutoGen Definitions output
> #---------------------------------------------------------------------------
> GENERATE_AUTOGEN_DEF   = NO
> #---------------------------------------------------------------------------
> # Configuration options related to the Perl module output
> #---------------------------------------------------------------------------
> GENERATE_PERLMOD       = NO
> PERLMOD_LATEX          = NO
> PERLMOD_PRETTY         = YES
> PERLMOD_MAKEVAR_PREFIX =
> #---------------------------------------------------------------------------
> # Configuration options related to the preprocessor
> #---------------------------------------------------------------------------
> ENABLE_PREPROCESSING   = YES
> MACRO_EXPANSION        = YES
> EXPAND_ONLY_PREDEF     = YES
> SEARCH_INCLUDES        = YES
> INCLUDE_PATH           = /path/to/sharkhome/doc/../include
> INCLUDE_FILE_PATTERNS  = *.h
> PREDEFINED             = DOXYGEN_SHOULD_SKIP_THIS
> EXPAND_AS_DEFINED      = SHARK_FEATURE_INTERFACE
> SKIP_FUNCTION_MACROS   = YES
> #---------------------------------------------------------------------------
> # Configuration options related to external references
> #---------------------------------------------------------------------------
> TAGFILES               =
> GENERATE_TAGFILE       = 
> /path/to/sharkhome/doc/doxygen_pages/tag_files/all.tag
> ALLEXTERNALS           = NO
> EXTERNAL_GROUPS        = YES
> EXTERNAL_PAGES         = YES
> PERL_PATH              = /usr/bin/perl
> #---------------------------------------------------------------------------
> # Configuration options related to the dot tool
> #---------------------------------------------------------------------------
> CLASS_DIAGRAMS         = YES
> MSCGEN_PATH            =
> HIDE_UNDOC_RELATIONS   = YES
> HAVE_DOT               = YES
> DOT_NUM_THREADS        = 0
> DOT_FONTNAME           = Helvetica
> DOT_FONTSIZE           = 10
> DOT_FONTPATH           =
> CLASS_GRAPH            = YES
> COLLABORATION_GRAPH    = YES
> GROUP_GRAPHS           = YES
> UML_LOOK               = YES
> 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           =
> DOT_GRAPH_MAX_NODES    = 200
> MAX_DOT_GRAPH_DEPTH    = 0
> DOT_TRANSPARENT        = YES
> DOT_MULTI_TARGETS      = NO
> GENERATE_LEGEND        = YES
> DOT_CLEANUP            = YES
> 
> 
> ------------------------------------------------------------------------------
> CenturyLink Cloud: The Leader in Enterprise Cloud Services.
> Learn Why More Businesses Are Choosing CenturyLink Cloud For
> Critical Workloads, Development Environments & Everything In Between.
> Get a Quote or Start a Free Trial Today. 
> http://pubads.g.doubleclick.net/gampad/clk?id=119420431&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: [Doxygen-users] 1.8.6 no longer creates references to pages

[Marcus S. <mar...@ho...>]

Hi,

> Nested comments are allowed now, but only if they are properly terminated,
> which is not the case in your example.
> If not then you should escape them like so: 
> 
>   file(GLOB SRC_FILES src/\*.c src/\*.cpp)<br/>
> 
> or use \verbatim..\endverbatim.
> 
> I've added a warning when such an comment is encountered to make it easier to find such problems.

I see, OK, thank you!


Marcus

-- 
Marcus Stein

Honda Research Institute Europe GmbH
Carl-Legien-Str. 30
63073 Offenbach/Main
Germany

Phone: +49 (0)69 / 89011-762
E-Mail: mar...@ho...

Re: [Doxygen-users] structures with attributes

[Thomas N. <nem...@gm...>]

You are right.

It's even in the documentation in the "Preprocessing" section.


2014/1/9 Richard Damon <Ri...@da...>

> On 1/9/14, 7:07 AM, Thomas Nemeth wrote:
> >
> >     Hi.
> >
> >     I'm documenting some structures that looks like this :
> >
> > /*! Dataset for status data. */
> > typedef struct __attribute__ ((__packed__)) {
> >         UINT16 outputs; /*!< Board outputs. */
> >         UINT32 inputs;  /*!< Board inputs. */
> >         UINT16 status;  /*!< Board status. */
> >         UINT16 errors;  /*!< Internal errors (bits field). */
> > } dataset_status;
> >
> >
> What i do for situations like this (I don't know if it is the best) is
> in the Doxygen config file predefine the "macro" __attribute__() to
> expand to nothing. This removes the attribute keyword clause, making the
> code look like standard C, and Doxygen can processes it.
>
> --
> Richard Damon
>
>
>
> ------------------------------------------------------------------------------
> CenturyLink Cloud: The Leader in Enterprise Cloud Services.
> Learn Why More Businesses Are Choosing CenturyLink Cloud For
> Critical Workloads, Development Environments & Everything In Between.
> Get a Quote or Start a Free Trial Today.
>
> http://pubads.g.doubleclick.net/gampad/clk?id=119420431&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>



-- 
| A: Yes.
| >Q: Are you sure?
| >>A: Because it reverses the logical flow of conversation.
| >>>Q: Why is top posting frowned upon?

[Doxygen-users] Strange "ttc"-class-div artifacts on source file pages

[Matthias T. <mat...@ru...>]

Hi,

we recently noticed "new" artifacts on the bottom of those
Doxygen html pages which show/reproduce our source files.
For example: on the bottom of this page

http://image.diku.dk/shark/doxygen_pages/html/_c_svm_grid_search_tutorial_8cpp_source.html 


there is a long list of tokens referenced that has not
been there a few weeks ago. Although they have some relation
to the source file, it does not seem to serve any purpose,
reads like gibberish, and I would like to exclude them from
the generated html, like it was the default before. So, can
anyone enlighten me what Doxygen option generates this list?
Is it a bug or feature? We could not find any change in our
setup which might have suddenly produced this output.

In the raw html for the above page, all these artifacts start
with <div class="ttc" id="...">, and a grep for that shows
that the ttc class seems to be reserved for these annoying
artifacts. But I'd very much rather eliminate them from within
Doxygen than via CSS. System stats and config file are below.

Thanks for any pointers!
Matthias


$ doxygen -version
1.8.5

$ uname -a
Linux host 3.12.1-3-ARCH #1 SMP PREEMPT Tue Nov 26 11:17:02 CET 2013 
x86_64 GNU/Linux
[but also on other systems]



# Doxyfile 1.8.5

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING      = UTF-8
PROJECT_NAME           = Shark
PROJECT_NUMBER         = 3.0.0
PROJECT_BRIEF          =
PROJECT_LOGO           =
OUTPUT_DIRECTORY       = /path/to/sharkhome/doc/doxygen_pages
CREATE_SUBDIRS         = NO
OUTPUT_LANGUAGE        = English
BRIEF_MEMBER_DESC      = YES
REPEAT_BRIEF           = YES
ABBREVIATE_BRIEF       =
ALWAYS_DETAILED_SEC    = NO
INLINE_INHERITED_MEMB  = NO
FULL_PATH_NAMES        = YES
STRIP_FROM_PATH        = /path/to/sharkhome/doc/..
STRIP_FROM_INC_PATH    = /path/to/sharkhome/doc/../include
SHORT_NAMES            = NO
JAVADOC_AUTOBRIEF      = NO
QT_AUTOBRIEF           = NO
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS           = YES
SEPARATE_MEMBER_PAGES  = NO
TAB_SIZE               = 4
ALIASES                =
TCL_SUBST              =
OPTIMIZE_OUTPUT_FOR_C  = NO
OPTIMIZE_OUTPUT_JAVA   = NO
OPTIMIZE_FOR_FORTRAN   = NO
OPTIMIZE_OUTPUT_VHDL   = NO
EXTENSION_MAPPING      =
MARKDOWN_SUPPORT       = YES
AUTOLINK_SUPPORT       = YES
BUILTIN_STL_SUPPORT    = YES
CPP_CLI_SUPPORT        = NO
SIP_SUPPORT            = NO
IDL_PROPERTY_SUPPORT   = YES
DISTRIBUTE_GROUP_DOC   = NO
SUBGROUPING            = YES
INLINE_GROUPED_CLASSES = NO
INLINE_SIMPLE_STRUCTS  = NO
TYPEDEF_HIDES_STRUCT   = NO
LOOKUP_CACHE_SIZE      = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = NO
EXTRACT_PACKAGE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = NO
EXTRACT_ANON_NSPACES   = NO
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO
HIDE_FRIEND_COMPOUNDS  = NO
HIDE_IN_BODY_DOCS      = NO
INTERNAL_DOCS          = NO
CASE_SENSE_NAMES       = NO
HIDE_SCOPE_NAMES       = NO
SHOW_INCLUDE_FILES     = YES
FORCE_LOCAL_INCLUDES   = NO
INLINE_INFO            = YES
SORT_MEMBER_DOCS       = YES
SORT_BRIEF_DOCS        = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES       = NO
SORT_BY_SCOPE_NAME     = NO
STRICT_PROTO_MATCHING  = NO
GENERATE_TODOLIST      = YES
GENERATE_TESTLIST      = YES
GENERATE_BUGLIST       = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS       =
MAX_INITIALIZER_LINES  = 30
SHOW_USED_FILES        = YES
SHOW_FILES             = YES
SHOW_NAMESPACES        = YES
FILE_VERSION_FILTER    = "svnversion /path/to/sharkhome/doc/.."
LAYOUT_FILE            =
CITE_BIB_FILES         =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET                  = NO
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = NO
WARN_FORMAT            = "$file:$line: $text"
WARN_LOGFILE           =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
INPUT                  = /path/to/sharkhome/doc/../src \
                          /path/to/sharkhome/doc/../include \
                          /path/to/sharkhome/doc/../examples \
                          /path/to/sharkhome/doc/../examples \
                          /path/to/sharkhome/doc/../Test
INPUT_ENCODING         = UTF-8
FILE_PATTERNS          = *.h \
                          *.inl \
                          *.hpp \
                          *.cpp
RECURSIVE              = YES
EXCLUDE                =
EXCLUDE_SYMLINKS       = NO
EXCLUDE_PATTERNS       = */GLPK.cpp \
                          */.svn/* \
                          */Test/* \
                          *boost*
EXCLUDE_SYMBOLS        = boost::noncopyable \
                          *type*
EXAMPLE_PATH           = /path/to/sharkhome/doc/../examples
EXAMPLE_PATTERNS       = *.cpp
EXAMPLE_RECURSIVE      = YES
IMAGE_PATH             =
INPUT_FILTER           =
FILTER_PATTERNS        =
FILTER_SOURCE_FILES    = NO
FILTER_SOURCE_PATTERNS =
USE_MDFILE_AS_MAINPAGE =
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER         = YES
INLINE_SOURCES         = NO
STRIP_CODE_COMMENTS    = NO
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = NO
REFERENCES_LINK_SOURCE = NO
SOURCE_TOOLTIPS        = YES
USE_HTAGS              = NO
VERBATIM_HEADERS       = YES
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX     = YES
COLS_IN_ALPHA_INDEX    = 1
IGNORE_PREFIX          =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML          = YES
HTML_OUTPUT            = html
HTML_FILE_EXTENSION    = .html
HTML_HEADER            = 
/path/to/sharkhome/doc/doxygen_pages/templates/header.html
HTML_FOOTER            = 
/path/to/sharkhome/doc/doxygen_pages/templates/footer.html
HTML_STYLESHEET        =
HTML_EXTRA_STYLESHEET  =
HTML_EXTRA_FILES       =
HTML_COLORSTYLE_HUE    = 220
HTML_COLORSTYLE_SAT    = 100
HTML_COLORSTYLE_GAMMA  = 80
HTML_TIMESTAMP         = YES
HTML_DYNAMIC_SECTIONS  = YES
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       = 12
FORMULA_TRANSPARENT    = YES
USE_MATHJAX            = YES
MATHJAX_FORMAT         = HTML-CSS
MATHJAX_RELPATH        = 
http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
MATHJAX_EXTENSIONS     =
MATHJAX_CODEFILE       =
SEARCHENGINE           = NO
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         = NO
LATEX_OUTPUT           = latex
LATEX_CMD_NAME         = latex
MAKEINDEX_CMD_NAME     = makeindex
COMPACT_LATEX          = NO
PAPER_TYPE             =
EXTRA_PACKAGES         = amsmath \
                          amsfonts
LATEX_HEADER           =
LATEX_FOOTER           =
LATEX_EXTRA_FILES      =
PDF_HYPERLINKS         = YES
USE_PDFLATEX           = YES
LATEX_BATCHMODE        = NO
LATEX_HIDE_INDICES     = NO
LATEX_SOURCE_CODE      = NO
LATEX_BIB_STYLE        = plain
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF           = NO
RTF_OUTPUT             = rtf
COMPACT_RTF            = NO
RTF_HYPERLINKS         = NO
RTF_STYLESHEET_FILE    =
RTF_EXTENSIONS_FILE    =
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN           = NO
MAN_OUTPUT             = man
MAN_EXTENSION          = .3
MAN_LINKS              = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML           = NO
XML_OUTPUT             = xml
XML_SCHEMA             =
XML_DTD                =
XML_PROGRAMLISTING     = YES
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
GENERATE_DOCBOOK       = NO
DOCBOOK_OUTPUT         = docbook
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF   = NO
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD       = NO
PERLMOD_LATEX          = NO
PERLMOD_PRETTY         = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
SEARCH_INCLUDES        = YES
INCLUDE_PATH           = /path/to/sharkhome/doc/../include
INCLUDE_FILE_PATTERNS  = *.h
PREDEFINED             = DOXYGEN_SHOULD_SKIP_THIS
EXPAND_AS_DEFINED      = SHARK_FEATURE_INTERFACE
SKIP_FUNCTION_MACROS   = YES
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
TAGFILES               =
GENERATE_TAGFILE       = 
/path/to/sharkhome/doc/doxygen_pages/tag_files/all.tag
ALLEXTERNALS           = NO
EXTERNAL_GROUPS        = YES
EXTERNAL_PAGES         = YES
PERL_PATH              = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS         = YES
MSCGEN_PATH            =
HIDE_UNDOC_RELATIONS   = YES
HAVE_DOT               = YES
DOT_NUM_THREADS        = 0
DOT_FONTNAME           = Helvetica
DOT_FONTSIZE           = 10
DOT_FONTPATH           =
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = YES
GROUP_GRAPHS           = YES
UML_LOOK               = YES
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           =
DOT_GRAPH_MAX_NODES    = 200
MAX_DOT_GRAPH_DEPTH    = 0
DOT_TRANSPARENT        = YES
DOT_MULTI_TARGETS      = NO
GENERATE_LEGEND        = YES
DOT_CLEANUP            = YES

Re: [Doxygen-users] structures with attributes

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

On 1/9/14, 7:07 AM, Thomas Nemeth wrote:
>
>     Hi.
>
>     I'm documenting some structures that looks like this :
>
> /*! Dataset for status data. */
> typedef struct __attribute__ ((__packed__)) {
>         UINT16 outputs; /*!< Board outputs. */
>         UINT32 inputs;  /*!< Board inputs. */
>         UINT16 status;  /*!< Board status. */
>         UINT16 errors;  /*!< Internal errors (bits field). */
> } dataset_status;
>
>
What i do for situations like this (I don't know if it is the best) is
in the Doxygen config file predefine the "macro" __attribute__() to
expand to nothing. This removes the attribute keyword clause, making the
code look like standard C, and Doxygen can processes it.

-- 
Richard Damon

[Doxygen-users] structures with attributes

[Thomas N. <nem...@gm...>]

    Hi.

    I'm documenting some structures that looks like this :

/*! Dataset for status data. */
typedef struct __attribute__ ((__packed__)) {
        UINT16 outputs; /*!< Board outputs. */
        UINT32 inputs;  /*!< Board inputs. */
        UINT16 status;  /*!< Board status. */
        UINT16 errors;  /*!< Internal errors (bits field). */
} dataset_status;

    And here is the error message from doxygen :

pdtask.c:65: warning: Member dataset_status (variable) of group iptstr is
not documented.
[...]
pdtask.c:74: warning: return type of member __attribute__ is not documented

    How could I document such a structure so that not only there is
    no error message from doxygen, but also so that the produced
    documentation is correct.

    Actually that produces something like, for the file in question :

[...]
Functions
   struct __attribute__ ((__packed__))
[...other functions...]

    I could have a named structure, however no only I prefer the
    compactness of this kind of defintion, but also, I'm not sure
    it wouldn't produce the same result...


T.

-- 
| A: Yes.
| >Q: Are you sure?
| >>A: Because it reverses the logical flow of conversation.
| >>>Q: Why is top posting frowned upon?

[Doxygen-users] doxygen #define question

[<hew...@gm...>]

Hi there!  I have a question regarding the doxygen preprocessor.  In some of my code (.c) modules I have a #define setup to tell the .h file for that module how to behave.  For example in the following file (driver.c) I define the constant CDR:


#define CDR
#include "driver.h"


/**
 @brief Initialize all CAN1 Driver variables.
 @return none
*/
void initialize(void)
{
 //! @todo Run some code here...
 printf("%d", test_file_scope_variable);
}


Then in the header file (driver.h), I perform certain actions based on whether CDR has been defined.  For example, the static variable test_file_scope_variable below is only declared if CDR is defined.


#ifdef CDR /* LOCAL definition */


/**
 @var test_file_scope_variable
  File Scope variable to Test doxigen
*/
static u16 test_file_scope_variable;


#endif /* CDR */


All the above code works great at the compiler level but when I go to run doxygen the documentation generated never shows test_file_scope_variable since doxygen can't seem to see that CDR has been defined in the C module.  Does anyone know how to solve this?  I know that I can solve this by defining CDR using the PREDEFINED setting in the doxygen settings.  However this will define CDR for the whole project and I only want it defined only for this module and header combination.



Thanks!  Any help would be greatly appreciated!



-Joe

[Doxygen-users] How to generate a PDF with numbered bookmark pane

[Stefan H. <hei...@ho...>]

I generate a PDF out of doxygen's latex output using Miktex compiler. 
While the the document itself contains alphanumeric numbered headlines, 
the corresponding bookmark pane in the PDF file does only contain the 
text of the headlines, but not the numbering. Has someone a solution on 
how to get the bookmark pane also come up with numbered headlines?

Many thanks.
 		 	   		  

Re: [Doxygen-users] 1.8.6 no longer creates references to pages

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

Hi Marcus,

Nested comments are allowed now, but only if they are properly terminated, 
which is not the case in your example.
If not then you should escape them like so: 

  file(GLOB SRC_FILES src/\*.c src/\*.cpp)<br/>

or use \verbatim..\endverbatim.

I've added a warning when such an comment is encountered to make it easier to find such problems.

Regards,
  Dimitri

On 08 Jan 2014, at 9:41 , Marcus Stein <mar...@ho...> wrote:

> /*!
> * \mainpage
> *
> * \section About Welcome
> *
> * \li \ref Util_BuildSystemTools
> */
> 
> 
> /*!
> * \page Util Applications + libraries
> *
> * \li \subpage Util_BuildSystemTools
> */
> 
> 
> /*!
> * \page Util_BuildSystemTools Build System Tools + CMake
> *
> * \li \subpage Util_BuildSystemTools_CheatSheet
> *
> */
> 
> 
> /*!
> * \page Util_BuildSystemTools_CheatSheet CMake Cheat sheet
> *
> * <table>
> *
> * <tr>
> *   <th colspan="2">Defining targets</th>
> * </tr>
> * <tr>
> *   <td>building libraries</td>
> *   <td><tt>file(GLOB SRC_FILES src/*.c src/*.cpp)<br/>
> *           bst_build_libraries("${SRC_FILES}" "${PROJECT_NAME}"
> *           "${BST_LIBRARIES_SHARED}")</tt></td>
> * </tr>
> * </table>
> */

Re: [Doxygen-users] 1.8.6 no longer creates references to pages

[Marcus S. <mar...@ho...>]

Hi,

I was able to encircle the problem. If you run doxygen 1.8.6 on this:

-----------------------------------------------------------------------

/*!
 * \mainpage
 *
 * \section About Welcome
 *
 * \li \ref Util_BuildSystemTools
 */


/*!
 * \page Util Applications + libraries
 *
 * \li \subpage Util_BuildSystemTools
 */


/*!
 * \page Util_BuildSystemTools Build System Tools + CMake
 *
 * \li \subpage Util_BuildSystemTools_CheatSheet
 *
 */


/*!
 * \page Util_BuildSystemTools_CheatSheet CMake Cheat sheet
 *
 * <table>
 *
 * <tr>
 *   <th colspan="2">Defining targets</th>
 * </tr>
 * <tr>
 *   <td>building libraries</td>
 *   <td><tt>file(GLOB SRC_FILES src/*.c src/*.cpp)<br/>
 *           bst_build_libraries("${SRC_FILES}" "${PROJECT_NAME}"
 *           "${BST_LIBRARIES_SHARED}")</tt></td>
 * </tr>
 * </table>
 */


-----------------------------------------------------------------------

this error occurs:

example.h:20: warning: unable to resolve reference to
`Util_BuildSystemTools_CheatSheet' for \ref command

The problem seems to be related to the "src/*.c" in the table.
Maybe doxygen gets confused by the /* which looks like a comment start?

However, the same "/*" in a simpler case (without all the \page stuff)
works.


Regards,
Marcus

P.S. And thanks a lot, a lot, and a lot for the great tool  :-)



On 01/07/2014 02:30 PM, Dimitri van Heesch wrote:
> Hi Marcus,
> 
> The 2 comment blocks with the \page are not marked as special comments so
> doxygen will ignore them. Here is the corrected example:
> 
> /*!
> * \mainpage
> *
> * \ref A
> * \ref B
> *
> */
> 
> /*!
> * \page A
> * Hello, World!
> *
> */
> 
> /*!
> * \page B
> * doxygen rulez!
> *
> */
> 
> 
> Regards,
>   Dimiri
> 
> On 07 Jan 2014, at 11:11 , Marcus Stein <mar...@ho...> wrote:
> 
>> Hi @all,
>>
>> the doxygen manual says:
>>
>> "\ref <name> ["(text)"]
>> Creates a reference to a named section, subsection, page or anchor. [...]"
>>
>> This worked fine for me up to 1.8.5 but in 1.8.6 not anymore. Or is there
>> sth. wrong with the following construct?
>>
>>
>> /*!
>> * \mainpage
>> *
>> * \ref A
>> * \ref B
>> *
>> */
>>
>> /*
>> * \page A
>> * Hello, World!
>> *
>> */
>>
>> /*
>> * \page B
>> * doxygen rulez!
>> *
>> */
>>
>>> From 1.8.6 on these errors occur:
>>
>> example.h:4: warning: unable to resolve reference to `A' for \ref command
>> example.h:5: warning: unable to resolve reference to `B' for \ref command
>> example.h:4: warning: unable to resolve reference to `A' for \ref command
>> example.h:5: warning: unable to resolve reference to `B' for \ref command
>>
>>
>> Is this a bug or am I using it wrongly?
>>
>>
>> Thanks in advance,
>> Marcus
>>
>> -- 
>> Marcus Stein
>>
>> Honda Research Institute Europe GmbH
>> Carl-Legien-Str. 30
>> 63073 Offenbach/Main
>> Germany
>>
>> Phone: +49 (0)69 / 89011-762
>> E-Mail: mar...@ho...
>>
>> ------------------------------------------------------------------------------
>> 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-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 


-- 
Marcus Stein

Honda Research Institute Europe GmbH
Carl-Legien-Str. 30
63073 Offenbach/Main
Germany

Phone: +49 (0)69 / 89011-762
E-Mail: mar...@ho...

Re: [Doxygen-users] non-collapsible section in CHM

[Ron W. <ron...@gm...>]

Thanks. Must be a MS issue.


On Sat, Jan 4, 2014 at 4:46 AM, Albert <alb...@gm...> wrote:

> On my windows 7 machine I can collapse and expand the "Special Commands"
> section without problems.
> As far as I can see it looks like a local problem (which version of
> Windows are you using?) or maybe it is a special sequence of steps, can you
> reproduce the problem and describe the steps you made getting into this
> state?
>
>
>
> On Fri, Jan 3, 2014 at 10:38 PM, Ron Wilson <ron...@gm...> wrote:
>
>> Don't know if this is a Doxygen bug or Microsoft help viewer bug, but in
>> the Doxygen compressed help, the "Special Commands" section expanded, but I
>> can't collapse it.
>>
>> Screen picture attached.
>>
>>
>>
>> ------------------------------------------------------------------------------
>> 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-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>>
>

Re: [Doxygen-users] 1.8.6 no longer creates references to pages

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

Hi Marcus,

The 2 comment blocks with the \page are not marked as special comments so
doxygen will ignore them. Here is the corrected example:

/*!
* \mainpage
*
* \ref A
* \ref B
*
*/

/*!
* \page A
* Hello, World!
*
*/

/*!
* \page B
* doxygen rulez!
*
*/


Regards,
  Dimiri

On 07 Jan 2014, at 11:11 , Marcus Stein <mar...@ho...> wrote:

> Hi @all,
> 
> the doxygen manual says:
> 
> "\ref <name> ["(text)"]
> Creates a reference to a named section, subsection, page or anchor. [...]"
> 
> This worked fine for me up to 1.8.5 but in 1.8.6 not anymore. Or is there
> sth. wrong with the following construct?
> 
> 
> /*!
> * \mainpage
> *
> * \ref A
> * \ref B
> *
> */
> 
> /*
> * \page A
> * Hello, World!
> *
> */
> 
> /*
> * \page B
> * doxygen rulez!
> *
> */
> 
>> From 1.8.6 on these errors occur:
> 
> example.h:4: warning: unable to resolve reference to `A' for \ref command
> example.h:5: warning: unable to resolve reference to `B' for \ref command
> example.h:4: warning: unable to resolve reference to `A' for \ref command
> example.h:5: warning: unable to resolve reference to `B' for \ref command
> 
> 
> Is this a bug or am I using it wrongly?
> 
> 
> Thanks in advance,
> Marcus
> 
> -- 
> Marcus Stein
> 
> Honda Research Institute Europe GmbH
> Carl-Legien-Str. 30
> 63073 Offenbach/Main
> Germany
> 
> Phone: +49 (0)69 / 89011-762
> E-Mail: mar...@ho...
> 
> ------------------------------------------------------------------------------
> 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-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] 1.8.6 no longer creates references to pages

[Marcus S. <mar...@ho...>]

Hi @all,

the doxygen manual says:

"\ref <name> ["(text)"]
Creates a reference to a named section, subsection, page or anchor. [...]"

This worked fine for me up to 1.8.5 but in 1.8.6 not anymore. Or is there
sth. wrong with the following construct?


/*!
 * \mainpage
 *
 * \ref A
 * \ref B
 *
 */

/*
 * \page A
 * Hello, World!
 *
 */

/*
 * \page B
 * doxygen rulez!
 *
 */

>From 1.8.6 on these errors occur:

example.h:4: warning: unable to resolve reference to `A' for \ref command
example.h:5: warning: unable to resolve reference to `B' for \ref command
example.h:4: warning: unable to resolve reference to `A' for \ref command
example.h:5: warning: unable to resolve reference to `B' for \ref command


Is this a bug or am I using it wrongly?


Thanks in advance,
Marcus

-- 
Marcus Stein

Honda Research Institute Europe GmbH
Carl-Legien-Str. 30
63073 Offenbach/Main
Germany

Phone: +49 (0)69 / 89011-762
E-Mail: mar...@ho...

Re: [Doxygen-users] Doxygen .txt file inclusion

[Thomas N. <nem...@gm...>]

Nice !
That'll do it :)

Thanks for all.


2014/1/6 Paul Joireman <pau...@gm...>

> Thomas,
>
> I frequently inlcuded doxygen marked up documentation in a file with a dox
> extension and that was automatically picked up by Doxygen (last tried with
> 1.8.0).   The documentation does have to be enclosed in a doxygen comment
> block but
>
> /**
>   Your comment here
> */
>
> Would this suit your needs.
>
> Paul
>
>
> On Mon, Jan 6, 2014 at 8:50 AM, Thomas Nemeth <nem...@gm...>wrote:
>
>> Hi Albert.
>>
>>     I'm sorry not beeing clear enough :(
>>
>>     I actually have a bunch of documentation in doxygen format in a .txt
>> file
>>     and .h file that is modified to include that documentation each time
>> I change
>>     that documentation (using scripts/makefiles/...)
>>
>>     That is... Not for just 1 project, but for all of them.
>>
>>     What I would like to do is to have a special command just like
>> \include but
>>     that could include any file and treat it as a doxygen documentation
>> block.
>>
>>     I had a look at EXTENSION_MAPPING but that does not do what I need
>> (since it
>>     remaps an extention to a language... and so all the files with the
>> same
>>     extension -- well I could also change .txt to something else
>> obviously). And
>>     I don't want to include documentation in yet another format such as
>> markdown :)
>>
>>     If such a command does not exist, I'll give a try at extension
>> mapping...
>>
>>     Thanks.
>>
>> Thomas.
>>
>>
>> 2014/1/6 Albert <alb...@gm...>
>>
>>> Hi Thomas,
>>>
>>> It is not 100% clear what you want to achieve, but have you looked at
>>> EXTENSION_MAPPING and at the markdown possibilities?
>>>
>>> Albert
>>>
>>>
>>> On Mon, Jan 6, 2014 at 2:56 PM, Thomas Nemeth <nem...@gm...>wrote:
>>>
>>>>
>>>>     Hi.
>>>>
>>>>     I'd like to include in my projects documentation, some doxygen
>>>> documentation
>>>>     that lies in a non-source-code file (eg: .txt). Up to new I had to
>>>> manually
>>>>     copy/paste (well, not really manually, but using head/cat/tail
>>>> using a makefile)
>>>>     into a .h file so that the titlepage and some general documentation
>>>> is included.
>>>>
>>>>     However, this is a bit non portable. I've searched through the
>>>> documentation to
>>>>     know if a special command could include such a file. But all I
>>>> could find is
>>>>     \include which is like including code. But I'd like to include
>>>> documentation
>>>>     with \section, \subsection and all...
>>>>
>>>>     Is there anything like that ?
>>>>
>>>>
>>>> Thomas.
>>>>
>>>> --
>>>> | A: Yes.
>>>> | >Q: Are you sure?
>>>> | >>A: Because it reverses the logical flow of conversation.
>>>> | >>>Q: Why is top posting frowned upon?
>>>>
>>>>
>>>> ------------------------------------------------------------------------------
>>>> 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-users mailing list
>>>> Dox...@li...
>>>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>>>
>>>>
>>>
>>
>>
>> --
>> | A: Yes.
>> | >Q: Are you sure?
>> | >>A: Because it reverses the logical flow of conversation.
>> | >>>Q: Why is top posting frowned upon?
>>
>>
>> ------------------------------------------------------------------------------
>> 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-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>>
>
>
> --
> Paul W. Joireman
> pau...@gm...
>
> ----------------------------------------------------------------
> 'Am I not destroying my enemies when I make friends of them? ."
> -- Abraham Lincoln 1809-1865
>



-- 
| A: Yes.
| >Q: Are you sure?
| >>A: Because it reverses the logical flow of conversation.
| >>>Q: Why is top posting frowned upon?

Re: [Doxygen-users] Doxygen .txt file inclusion

[Paul J. <pau...@gm...>]

Thomas,

I frequently inlcuded doxygen marked up documentation in a file with a dox
extension and that was automatically picked up by Doxygen (last tried with
1.8.0).   The documentation does have to be enclosed in a doxygen comment
block but

/**
  Your comment here
*/

Would this suit your needs.

Paul


On Mon, Jan 6, 2014 at 8:50 AM, Thomas Nemeth <nem...@gm...>wrote:

> Hi Albert.
>
>     I'm sorry not beeing clear enough :(
>
>     I actually have a bunch of documentation in doxygen format in a .txt
> file
>     and .h file that is modified to include that documentation each time I
> change
>     that documentation (using scripts/makefiles/...)
>
>     That is... Not for just 1 project, but for all of them.
>
>     What I would like to do is to have a special command just like
> \include but
>     that could include any file and treat it as a doxygen documentation
> block.
>
>     I had a look at EXTENSION_MAPPING but that does not do what I need
> (since it
>     remaps an extention to a language... and so all the files with the same
>     extension -- well I could also change .txt to something else
> obviously). And
>     I don't want to include documentation in yet another format such as
> markdown :)
>
>     If such a command does not exist, I'll give a try at extension
> mapping...
>
>     Thanks.
>
> Thomas.
>
>
> 2014/1/6 Albert <alb...@gm...>
>
>> Hi Thomas,
>>
>> It is not 100% clear what you want to achieve, but have you looked at
>> EXTENSION_MAPPING and at the markdown possibilities?
>>
>> Albert
>>
>>
>> On Mon, Jan 6, 2014 at 2:56 PM, Thomas Nemeth <nem...@gm...>wrote:
>>
>>>
>>>     Hi.
>>>
>>>     I'd like to include in my projects documentation, some doxygen
>>> documentation
>>>     that lies in a non-source-code file (eg: .txt). Up to new I had to
>>> manually
>>>     copy/paste (well, not really manually, but using head/cat/tail using
>>> a makefile)
>>>     into a .h file so that the titlepage and some general documentation
>>> is included.
>>>
>>>     However, this is a bit non portable. I've searched through the
>>> documentation to
>>>     know if a special command could include such a file. But all I could
>>> find is
>>>     \include which is like including code. But I'd like to include
>>> documentation
>>>     with \section, \subsection and all...
>>>
>>>     Is there anything like that ?
>>>
>>>
>>> Thomas.
>>>
>>> --
>>> | A: Yes.
>>> | >Q: Are you sure?
>>> | >>A: Because it reverses the logical flow of conversation.
>>> | >>>Q: Why is top posting frowned upon?
>>>
>>>
>>> ------------------------------------------------------------------------------
>>> 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-users mailing list
>>> Dox...@li...
>>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>>
>>>
>>
>
>
> --
> | A: Yes.
> | >Q: Are you sure?
> | >>A: Because it reverses the logical flow of conversation.
> | >>>Q: Why is top posting frowned upon?
>
>
> ------------------------------------------------------------------------------
> 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-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>


-- 
Paul W. Joireman
pau...@gm...

----------------------------------------------------------------
'Am I not destroying my enemies when I make friends of them? ."
-- Abraham Lincoln 1809-1865

Re: [Doxygen-users] Doxygen .txt file inclusion

[Thomas N. <nem...@gm...>]

Hi Albert.

    I'm sorry not beeing clear enough :(

    I actually have a bunch of documentation in doxygen format in a .txt
file
    and .h file that is modified to include that documentation each time I
change
    that documentation (using scripts/makefiles/...)

    That is... Not for just 1 project, but for all of them.

    What I would like to do is to have a special command just like \include
but
    that could include any file and treat it as a doxygen documentation
block.

    I had a look at EXTENSION_MAPPING but that does not do what I need
(since it
    remaps an extention to a language... and so all the files with the same
    extension -- well I could also change .txt to something else
obviously). And
    I don't want to include documentation in yet another format such as
markdown :)

    If such a command does not exist, I'll give a try at extension
mapping...

    Thanks.

Thomas.


2014/1/6 Albert <alb...@gm...>

> Hi Thomas,
>
> It is not 100% clear what you want to achieve, but have you looked at
> EXTENSION_MAPPING and at the markdown possibilities?
>
> Albert
>
>
> On Mon, Jan 6, 2014 at 2:56 PM, Thomas Nemeth <nem...@gm...>wrote:
>
>>
>>     Hi.
>>
>>     I'd like to include in my projects documentation, some doxygen
>> documentation
>>     that lies in a non-source-code file (eg: .txt). Up to new I had to
>> manually
>>     copy/paste (well, not really manually, but using head/cat/tail using
>> a makefile)
>>     into a .h file so that the titlepage and some general documentation
>> is included.
>>
>>     However, this is a bit non portable. I've searched through the
>> documentation to
>>     know if a special command could include such a file. But all I could
>> find is
>>     \include which is like including code. But I'd like to include
>> documentation
>>     with \section, \subsection and all...
>>
>>     Is there anything like that ?
>>
>>
>> Thomas.
>>
>> --
>> | A: Yes.
>> | >Q: Are you sure?
>> | >>A: Because it reverses the logical flow of conversation.
>> | >>>Q: Why is top posting frowned upon?
>>
>>
>> ------------------------------------------------------------------------------
>> 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-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>>
>


-- 
| A: Yes.
| >Q: Are you sure?
| >>A: Because it reverses the logical flow of conversation.
| >>>Q: Why is top posting frowned upon?