doxygen-users — List for users of doxygen

Re: [Doxygen-users] Config file diff

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

Fabian,

There is, to the best of my knowledge, no such switch. There is the option
-s which only outputs the options and some comment, but you are probably
not hinting at this option.

Best Regards,

Albert



On Wed, Jun 3, 2015 at 12:17 PM, Fabian Cenedese <Cen...@in...> wrote:

> At 11:55 03.06.2015, Albert wrote:
> >Hi Fabian,
> >
> >Doxygen has the possibility to write the output to the terminal: doxygenb
> -g -
> >like is written in the help  when issueing doxygen --help:
> >1) Use doxygen to generate a template configuration file:
> >Â Â Â  doxygen [-s] -g [configName]
> >Â Â Â If - is used for configName doxygen will write to standard output.
> >
> >The diff command would also be a bit different, more like:
> >doxygen -g - | diff - Doxyfile
>
> I know these switches but I had the impression that there is a
> doxygen switch that also does the diff. That could be useful for
> e.g. mailinglists to not have to send the whole config file but
> only the necessary changes. Especially on Windows where
> a command line diff is not readily available.
>
> bye  Fabi
>
>
>
> ------------------------------------------------------------------------------
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Re: [Doxygen-users] Config file diff

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

At 11:55 03.06.2015, Albert wrote:
>Hi Fabian,
>
>Doxygen has the possibility to write the output to the terminal: doxygenb -g -
>like is written in the help  when issueing doxygen --help:
>1) Use doxygen to generate a template configuration file:
>Â Â Â  doxygen [-s] -g [configName]
>Â Â Â If - is used for configName doxygen will write to standard output.
>
>The diff command would also be a bit different, more like:
>doxygen -g - | diff - Doxyfile

I know these switches but I had the impression that there is a
doxygen switch that also does the diff. That could be useful for
e.g. mailinglists to not have to send the whole config file but
only the necessary changes. Especially on Windows where
a command line diff is not readily available.

bye  Fabi

Re: [Doxygen-users] Config file diff

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

Hi Fabian,

Doxygen has the possibility to write the output to the terminal: doxygenb
-g -
like is written in the help  when issueing doxygen --help:
1) Use doxygen to generate a template configuration file:
    doxygen [-s] -g [configName]

    If - is used for configName doxygen will write to standard output.


The diff command would also be a bit different, more like:
doxygen -g - | diff - Doxyfile


Albert

On Wed, Jun 3, 2015 at 11:30 AM, Fabian Cenedese <Cen...@in...> wrote:

> Hi
>
> Maybe I'm imagining things but I had the impression that
> there is a command line switch that would let doxygen
> print the changes in the given config file compared to the
> default as generated by -g. Something like
>
> diff (doxygen -g) MyDoxyFile
>
> But I don't see anything in the --help output nor on the
> doxygen website. Is this an undocumented parameter?
> Or wishful thinking?
>
> Thanks
>
> bye  Fabi
>
>
>
> ------------------------------------------------------------------------------
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

[Doxygen-users] Config file diff

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

Hi

Maybe I'm imagining things but I had the impression that
there is a command line switch that would let doxygen
print the changes in the given config file compared to the
default as generated by -g. Something like

diff (doxygen -g) MyDoxyFile

But I don't see anything in the --help output nor on the
doxygen website. Is this an undocumented parameter?
Or wishful thinking?

Thanks

bye  Fabi

Re: [Doxygen-users] The details of a function template are not accessible in generated documentation

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

Hi Albert,
Did you try to generate the documentation with the file I supplied above and
did it work for you after you documented the namespace?
Because, even when I document the namespace, I have the same problem.
I have submitted the issue on bugzilla.
Diarmuid



--
View this message in context: http://doxygen.10944.n7.nabble.com/The-details-of-a-function-template-are-not-accessible-in-generated-documentation-tp7196p7198.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] The details of a function template are not accessible in generated documentation

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

Problem looks to be related to not documented namespace. When documenting
the namespace the links work.
I think the 'More...'  should not be present, probably best is to file a
bug report in bugzilla.

Albert

On Thu, May 28, 2015 at 12:07 PM, didje <dia...@pd...> wrote:

> Doxygen 1.8.7
>
> I am generating documentation for the following file (don't ask me what the
> file is for, I don't know, I'm not the programmer..):
>
> /*!
>  * \file TestHelpMe.h
>  * \brief Here is the brief text.
>  * \details Here are the details
>  */
>
> namespace NAMESPACE_X {
>
>
> /*! \brief Here is the brief function text
>  * \details Here is the detailed function text.
>  *
>  * \param it some text.
>  */
> template<int i>
> void doSomeStuff (i it) {
> cout << "Hello" << endl;
> }
>
> }
>
> Doxygen generates documentation as in the image attached
>
> <http://doxygen.10944.n7.nabble.com/file/n7196/TestHelpMe.png>
>
> However, when I click the "More" link for the "doSomeStuff" function, it
> does not expand to show the text indicated by the \details tab, or send me
> down the page to some other expanded version of this documentation.
>
> Why is the "More" link not operational and is there any way for me to make
> it so ?
>
> Thanks,
>
>
>
>
> --
> View this message in context:
> http://doxygen.10944.n7.nabble.com/The-details-of-a-function-template-are-not-accessible-in-generated-documentation-tp7196.html
> Sent from the Doxygen - Users mailing list archive at Nabble.com.
>
>
> ------------------------------------------------------------------------------
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

[Doxygen-users] The details of a function template are not accessible in generated documentation

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

Doxygen 1.8.7

I am generating documentation for the following file (don't ask me what the
file is for, I don't know, I'm not the programmer..):

/*!
 * \file TestHelpMe.h
 * \brief Here is the brief text.
 * \details Here are the details
 */

namespace NAMESPACE_X {


/*! \brief Here is the brief function text
 * \details Here is the detailed function text.
 *
 * \param it some text.
 */
template<int i>
void doSomeStuff (i it) {
cout << "Hello" << endl;  
}

}

Doxygen generates documentation as in the image attached

<http://doxygen.10944.n7.nabble.com/file/n7196/TestHelpMe.png> 

However, when I click the "More" link for the "doSomeStuff" function, it
does not expand to show the text indicated by the \details tab, or send me
down the page to some other expanded version of this documentation.

Why is the "More" link not operational and is there any way for me to make
it so ?

Thanks,




--
View this message in context: http://doxygen.10944.n7.nabble.com/The-details-of-a-function-template-are-not-accessible-in-generated-documentation-tp7196.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Hiding "internal" files

[Braden M. <br...@en...>]

I am finding that when I mark a \file doc-comment with \internal and 
set "INTERNAL_DOCS = NO", the file is still visible in the file list 
(even though the documentation for it is absent).

Is there some other convenient way to suppress these (when I'm not 
generating internal docs), or would I just have to list the files in 
EXCLUDE?

I see some reference to the potential utility of a hypothetical 
HIDE_UNDOC_FILES option dating back to 2003[1], though that seems not to 
have magically materialized in the meantime.

I am using doxygen 1.8.9.1.

[1] http://sourceforge.net/p/doxygen/mailman/message/9028776/

-- 
Braden McDaniel
<br...@en...>

[Doxygen-users] Warning: End of file while inside a group

[dbostream <gr...@ho...>]

As the title says Doxygen doesn't seem to notice my closing "}" of the group.
This is what my Python file looks like:

##
#   @defgroup api_ironpy IronPython
#   @brief IronPython API
#
#   @defgroup api_ironpy_foo Foo
#   @ingroup api_ironpy
#   @{
#

My Foo class definition goes here...

##
#   @}
#

Even if I remove my class definition and just create the group I get the
same warning, so my class is not interfering. Any idea what is causing this
and how it can be fixed? I am using the default settings created by
Doxywizard and this is the only source file in my Doxygen project.

I have used the same procedure when creating groups in another project
(C++/C# instead of Python) without problems, in those files it looks like
this:

///
/// @defgroup api_c_cpp C/C++
/// @brief C/C++ API
///
/// @defgroup api_c_cpp_bar Bar
/// @ingroup api_c_cpp
/// @{
///

Code goes here...

///
/// @}
///

I would appreciate any help.



--
View this message in context: http://doxygen.10944.n7.nabble.com/Warning-End-of-file-while-inside-a-group-tp7193.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] EXCLUDE_PATTERNS for absolute paths

[Martin H. <mar...@or...>]

Hi,
I am trying to use the EXCLUDE_PATTERNS to exclude certain absolute 
paths, that is, they are relative to the source tree root. I want to 
exclude the directory A/foo/fie where A is the top directory of the 
distribution. I don't want to exclude any other directories, e.g. 
A/fum/foo/fie. I have tried the combinations

EXCLUDE_PATTERNS = foo/fie
EXCLUDE_PATTERNS = foo/fie/*
EXCLUDE_PATTERNS = /foo/fie
EXCLUDE_PATTERNS = ./foo/fie
EXCLUDE_PATTERNS = /home/.../foo/fie (That is, the complete absolute path)

None of them work. The only one that works is EXCLUDE_PATTERNS = 
*/foo/fie/*, which I assume would wrongfully exclude e.g. A/test/foo/fie.

Any help is appreciated.

Regards,
Martin Hansson

Re: [Doxygen-users] Plantuml error in vs environment

[Jörg K. <j.k...@pr...>]

The solution i found has something to do with spaces in the PATH environment variable.
The problem is fixed if the PATH entries coming with vcvars32 or vcvarsall (setting the vs environment)
are placed AFTER the existing path entries. Then the java executable required for plantuml.jar is run as also
epstopdf is found.
In the normal shell it worked, but in doxygen environment something happend to the path environment if it contains spaces ( what is normal on windows ).


> Hi!
> 
> i am using plantuml support in doxygen with 1.8.8.
> 
> after update to 1.8.9.1, i get errors in visual studio
> environment. In a windows enviroment with only mingw support,
> i.e. path set to mingw\bin everything is fine
> 
> if i run doxygen from the visual studio console, plantuml seems to return
> an invalid exit code.
> 
> But plantuml itself seems to work. calling plantuml with the generated pu file 
> does work
> as expected.
> 
> Also the slash/backslash handling seems not to be a problem.
> 
> Any hints?
>

Re: [Doxygen-users] Doxygen outputs blank files

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

At 20:02 19.05.2015, svasilieva wrote:
>I do not have a /file entry for the files.

I do not use fortran but try this:

http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdfile

---------------------------
Important:
    The documentation of global functions, variables, typedefs, and enums will only be included in the output if the file they are in is documented as well.
---------------------------

Try also to use EXTRACT_ALL=YES until the problems are sorted out.

bye  Fabi

Re: [Doxygen-users] Doxygen outputs blank files

[svasilieva <sva...@em...>]

I do not have a /file entry for the files.
One of the documentation blocks:

!> Procedure  
!!     ftn  IMPORT 

!> Abstract 
!!     This program is used in text text text text text text 
!!     text text text text text text text text text text text text text
!!
!> Disclaimer 
!!     None 
!! 
!> Required_Reading 
!!
!!     R.W. Gaskell, et.al, "Characterizing and navigating small bodies  
!!           with imaging data", Meteoritics & Planetary Science 43,  
!!           Nr 6, 1049-1061 (2008) 
!! 
!> Declarations 



--
View this message in context: http://doxygen.10944.n7.nabble.com/Doxygen-outputs-blank-files-tp7186p7189.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] doxywizard can't run PlantUML

[Michael S. P. <msp...@ra...>]

I am trying to use the doxywizard with PlantUML.  PlantUML works fine by itself.  But when the doxywizard gets to the step to invoke PlantUML, it throws up a dialog saying "choose the program you want to use to open this file: java.exe".  Why is it trying to "open" java.exe?  It should just run it!  I'm on Windows 7 Professional, 64-bit.  Doxygen is 1.8.9.1 installed from the binary distribution doxygen-1.8.9.1-setup.exe.

Any help is appreciated!

Re: [Doxygen-users] Doxygen outputs blank files

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

At 00:53 19.05.2015, Stephania Vasilieva wrote:
>I have over 100 files ending in .f
>I made sure that all of the comments have the correct fortran syntax (specifically !> and !!), and chose the "optimize for fortran" option on dozywizard. However, dozywizard keeps outputing empty documents. It runs and outputs lines saying "reading" "parsing and "prepassing". I haven't touched anything else. 
>Would it be a problem with my documentation, or am I missing something with doxygen?

Please show an example of one file documentation block.
Do you have a \file (or equivalent) entry for the file itself?

bye  Fabi

[Doxygen-users] Doxygen outputs blank files

[Stephania V. <sva...@em...>]

I have over 100 files ending in .f
I made sure that all of the comments have the correct fortran syntax
(specifically !> and !!), and chose the "optimize for fortran" option on
dozywizard. However, dozywizard keeps outputing empty documents. It runs
and outputs lines saying "reading" "parsing and "prepassing". I haven't
touched anything else.
Would it be a problem with my documentation, or am I missing something with
doxygen?

-- 
Stephania Vasilieva
Systems Engineering
Phone: 520-275-1552
Email: sva...@em...

[Doxygen-users] Hide method from “Public Member Functions" but not from "Member Function Doc."

[Chris D. <chr...@gm...>]

Hey all:

  I have some member functions that I don't want to show up at the top of
the class page with all the brief descriptions, under "Public Member
Functions." However, I still want the member function to show up under
"Member Function Documentation." How do I do this?

I'm not talking about REPEAT_BRIEF, and I'm not talking about using
cond/endcond to completely hide a member function from the documentation.

Here's my related stackoverflow post:
http://stackoverflow.com/q/28754115/1639690
Thank you!

[Doxygen-users] preprocessor not handling object alias

[Chris K. <vic...@ya...>]

My project uses a macro as an alias for a globally defined engine, for brevity. The macro definition is as follows:#define gEngine theApp.m_Engine
This permits engine methods to be called as follows:gEngine.foo();
Unfortunately such calls appear in the References section of class documents as just "gEngine." which is not correct. If I edit my source and replace gEngine.foo() with theApp.m_Engine.foo(), the references are OK.My config file definitely has ENABLE_PREPROCESSING and MACRO_EXPANSION set to YES. Could I have found an issue with doxygen's parser, or am I missing something?
It's as if the references were being created from the raw source files, without preprocessing. 
Best regards,Chris
http://chordease.sourceforge.net/
PS I'm using doxygen 1.8.9.1, and Visual C++ (version 6.0) under Windows 7 64-bit.

Re: [Doxygen-users] bash functions with [\.-] function/method name parser

[<Ale...@ex...>]

Attachments

Von: Elgert, Alexander (ext)
Gesendet: Dienstag, 12. Mai 2015 12:18
An: dox...@li...
Betreff: [Doxygen-users] bash functions with [\.-] function/method name parser


Hello,



I found a little doxygen filter for bash functions:



http://www.cbica.upenn.edu/sbia/software/basis/apidoc/v1.0/doxyfilter-bash_8py_source.html



After a few changes, it works really fine for my sources (60_000 loc).

(Attached, plus Example file)



But there is a thing, which is really annoying, there are tons of bash-functions, which uses a dot or a minus in the function name (which is allowed in bash), for example:



function e.() {

      echo "hello"

}



Is there a chance to add the dot and the minus for function names, so that doxygen is able to parse these names correctly?

It would be very helpful.



Thank you.



Best regards,

Alexander Elgert


--
Deutsche Telekom AG
Seamless ICT Security Infrastructure & Management im Auftrag T-Systems International GmbH
Dipl. Inf Alexander Elgert Langwadener Strasse 17 64625 Bensheim
+49 176 22 717 661 (Mobil)
+49 671 9683-12 (Tel)
+49 671 9683-30 (Fax)

[Doxygen-users] bash functions with [\.-] function/method name parser

[<Ale...@ex...>]

Hello,



I found a little doxygen filter for bash functions:



http://www.cbica.upenn.edu/sbia/software/basis/apidoc/v1.0/doxyfilter-bash_8py_source.html



After a few changes, it works really fine for my sources (60_000 loc).

(Attached, plus Example file)



But there is a thing, which is really annoying, there are tons of bash-functions, which uses a dot or a minus in the function name (which is allowed in bash), for example:



function e.() {

      echo "hello"

}



Is there a chance to add the dot and the minus for function names, so that doxygen is able to parse these names correctly?

It would be very helpful.



Thank you.



Best regards,

Alexander Elgert


--
Deutsche Telekom AG
Seamless ICT Security Infrastructure & Management im Auftrag T-Systems International GmbH
Dipl. Inf Alexander Elgert Langwadener Strasse 17 64625 Bensheim
+49 176 22 717 661 (Mobil)
+49 671 9683-12 (Tel)
+49 671 9683-30 (Fax)

[Doxygen-users] C style comment in header file

[Marian G. <MG...@qn...>]

Hi,

I have a .h file with a number of macro definitions like this:

#define testOut 0x0001 /* Comment */

I was using Doxygen 1.7.5.1 and just upgraded to 1.8.9.1 (latest). With the new version, the C style comment is included in documentation. I do have a work around if I move the comment up one line or in front of the definition:

/* Comment */
#define testOut 0x0001
OR
/* Comment */ #define testOut 0x0001

However I hope this will be fixed in future versions.

Thank you,
Marian Gutica

[Doxygen-users] Changes in configuration file

[Brad B. <bra...@se...>]

Is there someplace where the changes and additions to the configuration 
file are documneted. This part of the doxygen API seems to change 
without notice. For example, the default setting for
     GENERATE_HTML
Has changed. See
http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_generate_html
as apposed to the following output:

trash>doxygen --version
1.8.9.1

trash>doxygen -g doxyfile > /dev/null
trash>grep '^GENERATE_HTML' doxyfile
GENERATE_HTML          = NO
GENERATE_HTMLHELP      = NO

[Doxygen-users] Three slashes to introduce brief comment

[Florian L. <mai...@xg...>]

Hello,

I use this syntax to make a only a brief description:

  /// true if the mapping along some axis should be ignored
  bool* _deadAxis;

JAVADOC_AUTOBRIEF is off, almost everything else is doxygens default.

It seems to work fine, the result is the same as prefixed with // @brief 
foobar.

But I have found it in the documentation nowhere.

There is something like that mentioned in 
http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html but it talks 
about at least two comment lines.

Is the syntax above ok that way? Or will it eventually cease to work some 
day?

Thanks,
Florian

Re: [Doxygen-users] Doxygen-non Ascii characters

[tsm21 <ts...@gm...>]

Thanks for the help... 



--
View this message in context: http://doxygen.10944.n7.nabble.com/Doxygen-non-Ascii-characters-tp7167p7173.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Doxygen puts \+ commands in LaTeX files : undefined control sequence

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

Hi Albert.

Thank you for you answer. I've worked on the issue by myself since my post
and found the solution. I use a
custom latex title page. I don't know why suddenly this
issue appeared since I do not remember having seen a
package upgrade when periodically upgrading my systems
but the solution was to refactor my old header.tex file

​Latex packages used in that file were no more correctly
setup.​


2015-04-02 18:58 GMT+02:00 Albert <alb...@gm...>:

>
> 1.8.7 is not yet that old (though the extension -2~precise1 to the version
> number is not known to me, might be something from ubuntu), but still it
> would be useful to see if you can reproduce the problem with version
> 1.8.9.1. I'm not familiar with a program called "doxygen-latex
> 1.8.7-2~precise1". The version of Texlive is also a bit old but I don't
> think the problem comes from this.
>


> On Thu, Apr 2, 2015 at 3:08 PM, Thomas Nemeth <nem...@gm...>
> wrote:
>
>>
>>     The reason is pdftex always complains of undefined
>>     control sequences. After looking at the errors and
>>     the .tex files, it seems that most of C macros got
>>     a \+ sequence between letters.
>>
>>     Eg : MESSAGE_SIZE becomes M\+E\+S\+S\+A\+G\+E\+\_\+\+S\+I\+Z\+E
>>
>