doxygen-users — List for users of doxygen

[Doxygen-users] The Python documentation example page is empty

[Ashton, T. N. <tri...@in...>]

I'm trying to use Doxygen to document a python file and the example page (
http://www.stack.nl/~dimitri/doxygen/manual/examples/pyexample/html/index.html)
is completely empty and gives no information about how the output is
supposed to look

[Doxygen-users] How to add arbitrary methods which don't exist in code

[digitaldonkey <em...@do...>]

PHP has the concept of  Magic Methods
<http://php.net/manual/en/language.oop5.magic.php>   and I'm searching a way
how to document them. 

PhpDocumentator provides a @method property which generates the methods in
documentation, even thou they don't exist in code. 

I've seen many questions to this on the list and in StackOverflow, but none
seems to be answered.

* https://stackoverflow.com/questions/18126608/doxygen-ignores-method
*
http://doxygen.10944.n7.nabble.com/Generating-documentation-without-a-function-definition-tt2248.html#a2250
*
http://doxygen.10944.n7.nabble.com/PHP-and-arbitrary-class-properties-tt3885.html
* http://doxygen.10944.n7.nabble.com/Custom-Methods-tt2748.html

These methods becomming more and more popular as people creating API's from
Json definitions.

Is there any best practice solution? 
A simple workaround would be to just write the doc-block with @method, but
doxygen refuses to add the doc ("warning: documented symbol `public string
myFunction' was not declared or defined."). 
Is there any setting to add them if not in code? 
Wouldn't it be a feature?

Thank you





--
Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html

[Doxygen-users] How to add arbitrary methods which don't exist in code

[digitaldonkey <em...@do...>]

PHP has the concept of  Magic Methods
<http://php.net/manual/en/language.oop5.magic.php>   and I'm searching a way
how to document them. 

PhpDocumentator provides a @method property which generates the methods in
documentation, even thou they don't exist in code. 

I've seen many questions to this on the list and in StackOverflow, but none
seems to be answered.

* https://stackoverflow.com/questions/18126608/doxygen-ignores-method
*
http://doxygen.10944.n7.nabble.com/Generating-documentation-without-a-function-definition-tt2248.html#a2250
*
http://doxygen.10944.n7.nabble.com/PHP-and-arbitrary-class-properties-tt3885.html
* http://doxygen.10944.n7.nabble.com/Custom-Methods-tt2748.html

These methods becomming more and more popular as people creating API's from
Json definitions.

Is there any best practice solution? 
A simple workaround would be to just write the doc-block with @method, but
doxygen refuses to add the doc ("warning: documented symbol `public string
myFunction' was not declared or defined."). 
Is there any setting to add them if not in code? 
Wouldn't it be a feature?

Thank you





--
Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html

[Doxygen-users] How I can generate custom html output

[Ismael B. C. C. <ism...@gm...>]

Is there a way to do that on Doxygen? I don't want to change only the CSS,
I want to generate my personalized HTML output. If there's no way to do
that, it's possible to add it? (I can program the feature as I think it
would be requested if the proposition gets accepted)

Regards

Ismael Correa C.

[Doxygen-users] External Documentation Linking Questions?

[Mark <dox...@er...>]

1. How to reference external documentation from a user tab?

I am attempting to use a tag file to reference an external doxygen-generated doc. References within Doxygen generated pages are working. E.g., my @mainpage content includes "@ref history". This link correctly links to the document listed in TAGFILES, i.e., it has

    href="../../ktxtools/html/toktx.html#history”. 

On the other hand I have a custom DoxygenLayout.xml with a user tab

        <tab type="user" url="@ref synopsis" title="KTX Tools”/>

where synopsis is another anchor in the same tag file as history. However in this case the relative path to the external document is missing. navtreedata.js contains 
   
    [ "KTX Tools", "toktx.html#synopsis", null ],

which becomes the value of the href in the generated treeview pane.

How can I get this reference to properly include the relative path? I do not want to have to manually add it to my user tabs. It’s too error prone with multiple files to change if the document paths are ever changed.

2. How to disambiguate tags with the same name?

I’m actually referencing 2 external documents. Some of the section names appear in both documents. Is there some way in the @ref command to use the name of the document (project) as part of the anchor identification to disambiguate these?

Regards

    -Mark

[Doxygen-users] Has to stop the tree view flashing?

[Mark <dox...@er...>]

I use the tree view for navigation (GENERATE_TREEVIEW = YES, DISABLE_INDEX = YES).

Every time I click in the tree view on something other than the current selection, the entire browser window is cleared and redrawn including the tree view and its separator. I find it the resulting flash very ugly and distracting. I want only the right-hand pane to be redrawn with the newly selected page.

Even worse, with the custom layout below which sets “files” visibility to no, after making a selection, not only do I get the flashing but the tree view is redrawn collapsed so that only the top most item is visible. This makes navigating through API documentation very difficult.

  <navindex>
    <tab type="mainpage" visible="yes" title=""/>
    <tab type="pages" visible="yes" title="" intro=""/>
    <tab type="modules" visible="yes" title="" intro=""/>
    <tab type="namespaces" visible="yes" title="">
      <tab type="namespacelist" visible="yes" title="" intro=""/>
      <tab type="namespacemembers" visible="yes" title="" intro=""/>
    </tab>
    <tab type="classes" visible="no" title="">
      <tab type="classlist" visible="yes" title="" intro=""/>
      <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
      <tab type="hierarchy" visible="no" title="" intro=""/>
      <tab type="classmembers" visible="no" title="" intro=""/>
    </tab>
    <tab type="files" visible="no" title="">
      <tab type="filelist" visible="no" title="" intro=""/>
      <tab type="globals" visible="yes" title="" intro=""/>
    </tab>
    <tab type="examples" visible="yes" title="" intro=""/>  
  </navindex>

How can I prevent these nasties?

Regards

    -Mark

Re: [Doxygen-users] Documented symbol `enum ABC NamespaceA::NamespaceB::XYZ' was not declared or defined

[<ste...@at...>]

Am 25.10.2017 um 10:02 schrieb didje:
> In doxygen, I am getting the following warning: Documented symbol `enum DDD
> NamespaceA::NamespaceB::XYZ' was not declared or defined.
> 
> The enum in question is not even documented in doxygen so I don't know why
> the message above is showing up. Note that the enum is outside a class.
> 
> namespace NamespaceA {
> namespace NamespaceB{
> enum DDD XYZ {
>     SORT_ASC      = 1,
>     SORT_DESC     = -1
> };
> }
> }

This is not valid C++ code!
g++ says:

ddd.hpp:3:6: error: use of enum 'DDD' without previous declaration
 enum DDD XYZ {
      ^~~
ddd.hpp:4:5: error: 'SORT_ASC' was not declared in this scope
     SORT_ASC      = 1,
     ^~~~~~~~
ddd.hpp:5:5: error: 'SORT_DESC' was not declared in this scope
     SORT_DESC     = -1
     ^~~~~~~~~
ddd.hpp:3:10: error: scalar object 'NamespaceA::NamespaceB::XYZ' requires one element in initializer
 enum DDD XYZ {
          ^~~


Not a Doxygen problem I would say

/S
-- 
----------------------------------------------------------------
/dev/random says: Canadian DOS: "Yer sure, eh?" [y/n]
python -c "print '73746566616e2e6e616577654061746c61732d656c656b74726f6e696b2e636f6d'.decode('hex')" 
GPG Key fingerprint = 2DF5 E01B 09C3 7501 BCA9  9666 829B 49C5 9221 27AF

[Doxygen-users] Warning message documented symbol enum was not declared or defined

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

In doxygen, I am getting the following warning: Documented symbol `enum DDD
NamespaceA::NamespaceB::XYZ' was not declared or defined.

The enum in question is not even documented in doxygen so I don't know why
the message above is showing up. Note that the enum is outside a class.

namespace NamespaceA {
namespace NamespaceB{
enum DDD XYZ {
    SORT_ASC      = 1,
    SORT_DESC     = -1
};
}
}

I have tried documenting the above enum.
I have also tried adding a \file tag to the file as well. However, I still
get the same warning message.

How do I get rid of the warning message ? Note that I'm using Doxygen 1.8.10



--
Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html

[Doxygen-users] Documented symbol `enum ABC NamespaceA::NamespaceB::XYZ' was not declared or defined

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

In doxygen, I am getting the following warning: Documented symbol `enum DDD
NamespaceA::NamespaceB::XYZ' was not declared or defined.

The enum in question is not even documented in doxygen so I don't know why
the message above is showing up. Note that the enum is outside a class.

namespace NamespaceA {
namespace NamespaceB{
enum DDD XYZ {
    SORT_ASC      = 1,
    SORT_DESC     = -1
};
}
}

I have tried documenting the above enum, adding a \file tag to the file as
well. However, I still get the same warning message.

How do I get rid of the warning message ? I'm using Doxygen 1.8.10



--
Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html

[Doxygen-users] Fortran module-submodule structure

[Norman K. <nor...@gm...>]

Dear doxygen community

I love doxygen! Recently Fortran has been encouraging users ot move to a
module-submodule structure to dramatically reduce compilation effort in
long use chains.  A module procedure might be declared public and the
interface specified at the level of the module but the body specified in a
submodule.

Doxygen does not seem to understand the public declaration and does not
document the public routine as a result, here is a brief example:

!> @brief Module consisting of declarations and interfaces
module a_module
public a_module_print
interface
    module subroutine a_module_print
    end subroutine a_module_print
end interface
end module a_module

!> @brief The working parts of a_module
submodule (a_module) a_module_subm
    contains
    !> @brief Only subroutine in this submodule
    !> @detail Declared public at the level of the module
    !! prints hello world
    module subroutine a_module_print
        write(*,*) 'Hello World of Submodules'
    end subroutine a_module_print
end submodule a_module_subm

!> @brief Demonstration of module-submodule structure
program test_doxygen_subm
    use, non_intrinsic :: a_module
    call a_module_print
    stop
end program test_doxygen_subm

Is this just a case of new features of Fortran not yet implemented in
doxygen, or am I missing something?

Thanks

-- 
*Prof Norman Kirkby*
Research Fellow

Faculty of Biology, Medicine and Health

The University of Manchester



[image: Description: cid:image002.jpg@01D1EC01.DD98DC00]


The Christie NHS Foundation Trust
First Floor, Wolfson Molecular Imaging Centre, 27 Palatine Road, Manchester
M20 3LJ
Phone 0161 275 0009

Due to the Paterson fire, my ics.manchester.ac.uk email is not working,
please use:
nor...@ma..., or nor...@gm...

Re: [Doxygen-users] [SOLVED] \ref within \defgroup

[Andreas T. <an...@vi...>]

On 20.10.2017 16:43, Andreas Tscharner wrote:
> Hello World,
> 
> I have a problem with \ref within a \defgroup
> 
> I define a group (in a /** \page)
> \defgroup inR16 Events and Requests available since QUARTIS R16
> @{
> \ref _charact_1<br/>
> \ref _charact_2<br/>
> @}
> 
> _charact_1 is defined as follows:
> \subsection _charact_1 Turn on/off characteristics
> text
> text
> ...
> 
> _charact_2 is similar, e.g. also a \subsection
> 
> I create a HTML documentation. I see both references in the module page 
> as links with the \subsection titles. The module page has the following 
> URL:
> file:///J:/QUARTIS/_dev/SDK/Automation/Doc/html/group__in_r16.html
> 
> But when I click on one of the links, I get an error, because the URL is 
> wrong:
> j:/QUARTIS/_dev/SDK/Automation/doc/Events.txt.html#_charact_1
> (no file:/// in front, completely wrong file: Events.txt is the origin 
> file for the documentation)
> 
> Is \ref within a \defgroup not supported or is this simply a bug?
> 

I found the solution myself: It did not work, because the references 
were defined later in the same file. I created a separate file for the 
\defgroup and it works as expected.

Sorry for bothering and best regards
	Andreas
-- 
       ("`-''-/").___..--''"`-._
        `o_ o  )   `-.  (     ).`-.__.`)
        (_Y_.)'  ._   )  `._ `. ``-..-'
      _..`--'_..-_/  /--'_.' .'
     (il).-''  (li).'  ((!.-'

Andreas Tscharner   an...@vi...   ICQ-No. 14356454

[Doxygen-users] \ref within \defgroup

[Andreas T. <an...@vi...>]

Hello World,

I have a problem with \ref within a \defgroup

I define a group (in a /** \page)
\defgroup inR16 Events and Requests available since QUARTIS R16
@{
\ref _charact_1<br/>
\ref _charact_2<br/>
@}

_charact_1 is defined as follows:
\subsection _charact_1 Turn on/off characteristics
text
text
...

_charact_2 is similar, e.g. also a \subsection

I create a HTML documentation. I see both references in the module page 
as links with the \subsection titles. The module page has the following URL:
file:///J:/QUARTIS/_dev/SDK/Automation/Doc/html/group__in_r16.html

But when I click on one of the links, I get an error, because the URL is 
wrong:
j:/QUARTIS/_dev/SDK/Automation/doc/Events.txt.html#_charact_1
(no file:/// in front, completely wrong file: Events.txt is the origin 
file for the documentation)

Is \ref within a \defgroup not supported or is this simply a bug?

TIA and best regards
	Andreas
-- 
       ("`-''-/").___..--''"`-._
        `o_ o  )   `-.  (     ).`-.__.`)
        (_Y_.)'  ._   )  `._ `. ``-..-'
      _..`--'_..-_/  /--'_.' .'
     (il).-''  (li).'  ((!.-'

Andreas Tscharner   an...@vi...   ICQ-No. 14356454

[Doxygen-users] doxygen rtf output (hu)

[Szabó Z. <sza...@gm...>]

I have two problems with doxygen rtf output:

The output language is hungarian(deprecatad).
The test project is generated with Qt Creator(windows 64 bit/Ubuntu linux
64 bit).
Doxygen version is 1.8.13.

1. In refman rtf the ő and ű characters are wrong, instead of double acute
there is a tilde like sign over them.
After reading the rich text specification(
http://www.biblioscape.com/rtf15_spec.htm), i have inserted \cpg1250 in the
fonts section of the rtf header like this:

{\fonttbl {\f0\froman\fcharset0\cpg1250\fprq2{\*\panose
02020603050405020304}Times New Roman;}
{\f1\fswiss\fcharset0\cpg1250\fprq2{\*\panose 020b0604020202020204}Arial;}
{\f2\fmodern\fcharset0\cpg1250\fprq1{\*\panose 02070309020205020404}Courier
New;}
{\f3\froman\fcharset2\cpg1250\fprq2{\*\panose 05050102010706020507}Symbol;}
}

After this in libreoffice the two characters are allright(but still wrong
in ms office 2010 though).

I am not sure this is the right fix for the problem, but partially works
for me.

2. The generated table of content gives the Error: Reference source not
found in almost all cases.
I have no idea why, because the corresponding \bkmstart and \bkmend entries
are there in the rtf source.

Any idea how to fix properly these problems?

Thanks in advance.

[Doxygen-users] How to move auto-generated pages like Modules, Files, etc.

[Petr P. <pet...@se...>]

Hi all,

I would like to ask there is a way to move the auto-generated pages 
Modules, Files, Todo List, etc. to another location in the document 
tree, i.e., under some subpage. Normally, they are the last pages under 
the top "project name".

Also, is there a way to rename those pages?

Best regards,

Petr Parik

Re: [Doxygen-users] Directory structure for the generated .html files?

[Alexandru B. <ab...@da...>]

It's not simple. The path for a/b/file.hh changes depending on whether
other files with the same name (file.hh) exist in the project. It can be
file_8hh.html if the name is unique, or a_2b_2file_8hh.html if there is
another one called c/file.hh.

Is there a way to generate the html documentation such that it's simple to
figure out the resulting path for a specific file, based on the file path
alone?

On Mon, Oct 2, 2017 at 2:12 PM Richard Damon <Ri...@da...>
wrote:

> On 10/2/17 7:25 AM, Alexandru Băluț wrote:
> > The files generated in the html/ directory are all in the same
> > directory. What rule can be used to convert the source-file path to
> > the URL where its doxygen documentation can be found? For example if I
> > know the file is "project1/Patch.hh", how can I construct the
> > "html/Patch_8hh_source.html" path so I can link to it from other places.
> >
> > Is there any way to configure Doxygen to use something like
> > "html/project1/Patch.html" so links to it can be created automatically
> > easily?
> >
> > Thanks,
> > Alex
> The file name conversion is fairly simple (and for me, I would get
> html/_patch_8hh_source.html I think you must have used case sensitive
> paths, which is OK as long as you are certain the results never need to
> live on a case insensitive system).
>
> Basically, for a case insensitive system, upper case letters are
> replaces with _ and the lower case letter. 'Special' characters, like .
> are replaced with _ and an number (like the 8 in your above example),
> and those numbers are consistent. Most of the files for pages are easy
> to predict the final name.
>
> Images on the other hand, are basically impossible to predict, as a hash
> is added to the name to allow the detection of needing to update the file.
>
> --
> Richard Damon
>
>
>
> ------------------------------------------------------------------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Re: [Doxygen-users] Directory structure for the generated .html files?

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

On 10/2/17 7:25 AM, Alexandru Băluț wrote:
> The files generated in the html/ directory are all in the same 
> directory. What rule can be used to convert the source-file path to 
> the URL where its doxygen documentation can be found? For example if I 
> know the file is "project1/Patch.hh", how can I construct the 
> "html/Patch_8hh_source.html" path so I can link to it from other places.
>
> Is there any way to configure Doxygen to use something like 
> "html/project1/Patch.html" so links to it can be created automatically 
> easily?
>
> Thanks,
> Alex
The file name conversion is fairly simple (and for me, I would get 
html/_patch_8hh_source.html I think you must have used case sensitive 
paths, which is OK as long as you are certain the results never need to 
live on a case insensitive system).

Basically, for a case insensitive system, upper case letters are 
replaces with _ and the lower case letter. 'Special' characters, like . 
are replaced with _ and an number (like the 8 in your above example), 
and those numbers are consistent. Most of the files for pages are easy 
to predict the final name.

Images on the other hand, are basically impossible to predict, as a hash 
is added to the name to allow the detection of needing to update the file.

-- 
Richard Damon

[Doxygen-users] Directory structure for the generated .html files?

[Alexandru B. <ab...@da...>]

The files generated in the html/ directory are all in the same directory.
What rule can be used to convert the source-file path to the URL where its
doxygen documentation can be found? For example if I know the file is
"project1/Patch.hh", how can I construct the "html/Patch_8hh_source.html"
path so I can link to it from other places.

Is there any way to configure Doxygen to use something like
"html/project1/Patch.html" so links to it can be created automatically
easily?

Thanks,
Alex

[Doxygen-users] dot tool and tagfiles -> bug?

[Matthias W. <ma...@fy...>]

Dear doxygen community,
I use doxygen to document my libraries. I have two separate libraries A and B, where B depends on A like so:

    //library A
    struct A::aAnimal{};
    struct A::Dog : public A::aAnimal{};
    struct A::Snake : public A::aAnimal{};


----------


    //library B
    struct B::Cat : public A::aAnimal{};

Assume all of the classes documented with doxygen and both library A and B have a separate Doxyfile. For generating the documentations I do the following:
1. Generate tag file for library A
2. Generate tag file for library B
3. Generate the documentation for A using B's tagfile
4. Generate the documentation for B using A's tagfile

Now the dot tool creates the graph { aAnimal <- Dog; aAnimal <- Snake } in the documentation in A. However, I expected the graph { aAnimal <- Dog; aAnimal <- Snake; aAnimal <- Cat; }, i.e. by passing B's tagfile to A I thought that the dot tool realizes that there is an additional derivation of aAnimal in B.
I inspected the tagfiles and realized that the tagfile for B is missing the line

<base>A::aAnimal</base>

in the Cat compound. Adding the line makes it work as expected.
So my question is:
- is this a bug?
- or is there a deeper reason not to include this information in the tagfile for B?
with best regards
Matthias

[Doxygen-users] Latex macros in html output (without MathJax)

[Thomas B. <tho...@ul...>]

Hello,

I want to use Latex macros in doxygen for the html output (I'm not using 
MathJax). I saw an "EXTRA_PACKAGES" option in Doxyfile, but it seems 
only useful for the Latex output, not the html one. Is there a way to 
accomplish what I want without using MathJax ?

Thanks,

Thomas

Re: [Doxygen-users] doxygen build (current git version) fails "suddenly" (bison problem)

[Jens S. <Jen...@t-...>]

On Fri, 22 Sep 2017, Jens Schleusener wrote:

> Hi,
>
> just a small remark: I tried to compile the current git version of doxygen 
> under Linux (openSUSE Leap 42.3) and got "suddenly" (before it works many 
> times without any problems) the following error:
>
> [ 23%] Building CXX object 
> vhdlparser/CMakeFiles/vhdlparser.dir/VhdlParserIF.cpp.o
> [ 24%] Linking CXX static library ../lib/libvhdlparser.a
> [ 24%] Built target vhdlparser
> [ 24%] [BISON][constexp] Building parser with bison 2.7
> /usr/bin/bison: invalid argument ‘deprecated’ for ‘--warnings’
> Valid arguments are:
>   - ‘none            - no warnings’
>   - ‘midrule-values  - unset or unused midrule values’
>   - ‘yacc            - incompatibilities with POSIX Yacc’
>   - ‘conflicts-sr    - S/R conflicts’
>   - ‘conflicts-rr    - R/R conflicts’
>   - ‘other           - all other warnings’
>   - ‘all             - all of the above’
>   - ‘error           - warnings are errors’
> src/CMakeFiles/_doxygen.dir/build.make:303: recipe for target 
> 'generated_src/ce_parse.cpp' failed
>
> I don't have clue about "cmake" but that problem may eventually be caused by 
> a recent change in src/CMakeLists.txt:
>
> 66c66
> <     COMMAND ${BISON_EXECUTABLE} -l -d -p ce_parsexpYY
> ${CMAKE_SOURCE_DIR}/src/constexp.y -o ce_parse.c
> ---
> >     COMMAND ${BISON_EXECUTABLE} -l -d -p ce_parsexpYY -Wno-deprecated
> ${CMAKE_SOURCE_DIR}/src/constexp.y -o ce_parse.c
> 122c122
> < BISON_TARGET(constexp      constexp.y
> ${GENERATED_SRC}/ce_parse.cpp       COMPILE_FLAGS "${YACC_FLAGS}")
> ---
> > BISON_TARGET(constexp      constexp.y
> ${GENERATED_SRC}/ce_parse.cpp       COMPILE_FLAGS "-Wno-deprecated
> ${YACC_FLAGS}")
>
> So just for testing I replaced that file with the old one (9718 bytes,
> Aug 21 11:59) and the build process runs well.
>
> Maybe the version of the used "bison" program (2.7) is too old
> (current version is 3.0.4).

Still an addition: Surprisingly I found in the man page of the used 
"bison" release 2.7 under "Warning categories include:" the categories 
'deprecated' ("obsolete constructs") and 'no-CATEGORY' ("turn off warnings 
in CATEGORY") mentioned.

But manually tests with a fetched test file

  bison -Wdeprecated    test.y
  bison -Wno-deprecated test.y

failed and issued also the mention error message.

So I downloaded and compiled bison 3.0.4 myself and the error vanishes. To 
ensure it's not a problem of my openSUSE distro I downloaded and compiled 
also bison 2.7 myself and I could reproduce the error. So it seems a 
problem with bison 2.7 (bison 2.7.1 also issues that error, bison 3.0 not).

Regards

Jens

[Doxygen-users] doxygen build (current git version) fails "suddenly" (bison problem)

[Jens S. <Jen...@t-...>]

Hi,

just a small remark: I tried to compile the current git version of doxygen 
under Linux (openSUSE Leap 42.3) and got "suddenly" (before it works many 
times without any problems) the following error:

  [ 23%] Building CXX object vhdlparser/CMakeFiles/vhdlparser.dir/VhdlParserIF.cpp.o
  [ 24%] Linking CXX static library ../lib/libvhdlparser.a
  [ 24%] Built target vhdlparser
  [ 24%] [BISON][constexp] Building parser with bison 2.7
  /usr/bin/bison: invalid argument ‘deprecated’ for ‘--warnings’
  Valid arguments are:
    - ‘none            - no warnings’
    - ‘midrule-values  - unset or unused midrule values’
    - ‘yacc            - incompatibilities with POSIX Yacc’
    - ‘conflicts-sr    - S/R conflicts’
    - ‘conflicts-rr    - R/R conflicts’
    - ‘other           - all other warnings’
    - ‘all             - all of the above’
    - ‘error           - warnings are errors’
  src/CMakeFiles/_doxygen.dir/build.make:303: recipe for target 'generated_src/ce_parse.cpp' failed

I don't have clue about "cmake" but that problem may eventually be caused 
by a recent change in src/CMakeLists.txt:

  66c66
  <     COMMAND ${BISON_EXECUTABLE} -l -d -p ce_parsexpYY
  ${CMAKE_SOURCE_DIR}/src/constexp.y -o ce_parse.c
  ---
  >     COMMAND ${BISON_EXECUTABLE} -l -d -p ce_parsexpYY -Wno-deprecated
  ${CMAKE_SOURCE_DIR}/src/constexp.y -o ce_parse.c
  122c122
  < BISON_TARGET(constexp      constexp.y
  ${GENERATED_SRC}/ce_parse.cpp       COMPILE_FLAGS "${YACC_FLAGS}")
  ---
  > BISON_TARGET(constexp      constexp.y
  ${GENERATED_SRC}/ce_parse.cpp       COMPILE_FLAGS "-Wno-deprecated
  ${YACC_FLAGS}")

So just for testing I replaced that file with the old one (9718 bytes,
Aug 21 11:59) and the build process runs well.

Maybe the version of the used "bison" program (2.7) is too old
(current version is 3.0.4).

Regards

Jens


-- 
Dr. Jens Schleusener
Schillerstr. 49
D-37083 Göttingen
Jen...@t-...

[Doxygen-users] ASN.1 filter for Doxygen

[Raashid A. <ans...@ya...>]

Hi All,
I have developed a Doxygen filter for ASN.1 in Python and would like reviews from the community about its applicability. Here's the link to my repo:https://bitbucket.org/raashid_ansari/asn1-doxygen-filter

Is it possible to get this included on the official Doxygen Extensions page?
Regards,
Raashid Ansari

[Doxygen-users] @namespace parsing issue with hyphenated names

[Raashid A. <ans...@ya...>]

Hi All,
I have built a parser for ASN.1 in Python. I use it to convert ASN.1 code to C++ish code. In ASN.1 you have a module name that encloses all other relevant structures in it, like a C++ namespace.
I am using the @namespace command to tell Doxygen to parse the module name as the namespace. The problem arises when a module name contains hyphens in it, e.g. "@namespace FileTransfer-profiles".
My parser parses this using the regex:
(?<=@namespace\s)[^\s-]+
Meaning it should return one to any number of characters on the same line that is not a space after @namespace. The parser's output in the above example is "FileTransfer-profiles". However, when I open Doxygen created documentation, all I see is "FileTransfer".
Am I missing something here? What can I do so that Doxygen gives me the whole module name with hyphens.
Regards,
Raashid

Re: [Doxygen-users] xrefitem overview page not generated properly

[René S. <r.s...@gm...>]

hmm - it seems that this problem comes from the combination of TYPEDEF_HIDES_STRUCT and the use of forward declaration of the following form:

/**
 * \component SomeComp
 *
 */
typedef struct sSomeComp_t SomeComp_t;


and then later:

/* Component SomeComp - for documentation, see above */
struct sSomeComp_t
{
  int dummy
};


If I set  TYPEDEF_HIDES_STRUCT to NO then the list is created but also i have all tag names in the documentation :(

I would consider this a bug, since the the \component is at the typedef.
I think the documenbtations of the typedef and the tag should be merged.


> Gesendet: Dienstag, 12. September 2017 um 10:11 Uhr
> Von: "René Staffen" <r.s...@gm...>
> An: dox...@li...
> Betreff: [Doxygen-users] xrefitem overview page not generated properly
>
> Hi,
> 
> i created the following xrefitem - alias:
> 
>    "component=\xrefitem componentList \"Component\" \"List of Components\" implements design component"
> 
> But the generated dokumentation lacks the corresponding entry in the "Related Pages" section .
> 
> The documented entities (that contain the component keyword) all correctly contain the section "Component". This section header is also a link but the targeted hml file does not exist.
> 
> So it seems that something is wrong with the main-page generation.
> I am not using any self defined template and also deleted the whole output folder and restarted the generation.
> 
> Any further ideas?
> 
> best regards
> René
> 
> ------------------------------------------------------------------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

[Doxygen-users] xrefitem overview page not generated properly

[René S. <r.s...@gm...>]

Hi,

i created the following xrefitem - alias:

   "component=\xrefitem componentList \"Component\" \"List of Components\" implements design component"

But the generated dokumentation lacks the corresponding entry in the "Related Pages" section .

The documented entities (that contain the component keyword) all correctly contain the section "Component". This section header is also a link but the targeted hml file does not exist.

So it seems that something is wrong with the main-page generation.
I am not using any self defined template and also deleted the whole output folder and restarted the generation.

Any further ideas?

best regards
René