doxygen-users — List for users of doxygen

[Doxygen-users] Doxygen does not generate documentation from html pages

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

Doxygen 1.8.10.

I generate documentation from a mix of .h files and .html files.
I was using Doxygen 1.8.7 and the documentation was generated correctly from
these sources.
However, I have just installed 1.8.10 and see that the .html files I
reference in my INPUT tag do not generate anything in the output
documentation.

I presume nothing was changed between 1.8.7 and 1.8.10 to prevent the use of
.html files for generating doxygen output, so I presume it must be a
configuration issue of some sort - however, when I look at the doxyfile
configuration file, there is no setting which has been added connected to
this, as far as I can see.





--
View this message in context: http://doxygen.10944.n7.nabble.com/Doxygen-does-not-generate-documentation-from-html-pages-tp7236.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Unable to build RPMs for Doxygen v1.8.10

[Jean A. <jau...@eu...>]

Hi!

Until the release 1.8.9.1, I was able to build Doxygen (binaires ands RPMs) with this command:
$ rpmbuild -ta doxygen-<VERSION>.src.tar.gz

With the last release, this command fails: "error: Failed to read spec file from doxygen-1.8.10.src.tar.gz"

I think it's related to the CMake build. So now, what is the best way to achieve build of RPMs?

Thanks a lot!

Jean


_________________________________________________________________

This message may contain confidential information and is intended for specific recipients unless explicitly noted otherwise. If you have reason to believe you are not an intended recipient of this message, please delete it and notify the sender. This message may not represent the opinion of Euronext N.V. or any of its subsidiaries or affiliates, and does not constitute a contract or guarantee. Unencrypted electronic mail is not secure and the recipient of this message is expected to provide safeguards from viruses and pursue alternate means of communication where privacy or a binding message is desired.

[Doxygen-users] background colour

[<pa...@ar...>]

I have noticed the doxygen home page has a colour blue in the title bar, matching the logo. I would like to have the same effect on my page, how can I do that?

thanks 

---
This email has been checked for viruses by Avast antivirus software.
http://www.avast.com

[Doxygen-users] doxygen-1.8.10 build problem (Linux)

[Schleusener, J. <Jen...@t-...>]

Hi,

I just downloaded the new

   http://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.10.src.tar.gz

but a

  build/cmake -G "Unix Makefiles" ..

under Linux (openSUSE 13.1; cmake 3.2.3) ends errorneously with

#########################################################################
-- The C compiler identification is GNU 4.8.1
-- The CXX compiler identification is GNU 4.8.1
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
CMake Error at CMakeLists.txt:29 (include):
   include could not find load file:

     version


-- Found PythonInterp: /usr/bin/python (found version "2.7.6")
-- Found FLEX: /usr/bin/flex (found version "2.5.37")
-- Found BISON: /usr/bin/bison (found version "2.7")
-- Looking for include file pthread.h
-- Looking for include file pthread.h - found
-- Looking for pthread_create
-- Looking for pthread_create - not found
-- Looking for pthread_create in pthreads
-- Looking for pthread_create in pthreads - not found
-- Looking for pthread_create in pthread
-- Looking for pthread_create in pthread - found
-- Found Threads: TRUE
CMake Error at CMakeLists.txt:64 (find_package):
   By not providing "FindIconv.cmake" in CMAKE_MODULE_PATH this project has
   asked CMake to find a package configuration file provided by "Iconv", 
but
   CMake did not find one.

   Could not find a package configuration file provided by "Iconv" with any 
of
   the following names:

     IconvConfig.cmake
     iconv-config.cmake

   Add the installation prefix of "Iconv" to CMAKE_PREFIX_PATH or set
   "Iconv_DIR" to a directory containing one of the above files.  If 
"Iconv"
   provides a separate development package or SDK, be sure it has been
   installed.


-- Configuring incomplete, errors occurred!
See also "/usr/local/src/doxygen-1.8.10/build/CMakeFiles/CMakeOutput.log".
See also "/usr/local/src/doxygen-1.8.10/build/CMakeFiles/CMakeError.log".
#########################################################################

Since I had no such problems with the git version I compared all the files 
of both distributions and found that at least the directory "cmake" 
(containing for e.g. the files version.cmake and FindIconv.cmake) is 
missing in the tarball. After I copied that directory testwise to the 
doxygen-1.8.10 source tree all works well.

Is that more a configuration problem on my side or maybe the directory 
"cmake" errorneously lacking in the tarball?

Regards

Jens

[Doxygen-users] suggest: strip leading indentation of @verbatim..@endverbatim block

[asmwarrior <asm...@gm...>]

I found this is an old question without get any replies in the year 2012 [1]

% cat foo.cpp
/**
 * \mainpage
 *
 * \verbatim
 * % foo --some-flag
 * some output
 * \endverbatim
 */
% doxygen - <<<'INPUT=foo.cpp'

Comes out (in html) as
|-----------------------|
| * % foo --some-flag   |
| * some output         |
| *                     |
|-----------------------|

You see the "*" in the output html? I think they should be removed as the what the @code and @endcode do, any ideas?

Thanks.

Asmwarrior


[1] Doxygen - Users - strip leading indentation of @verbatim..@endverbatim block - http://doxygen.10944.n7.nabble.com/strip-leading-indentation-of-verbatim-endverbatim-block-td925.html

Re: [Doxygen-users] Doxygen-users Digest, Vol 109, Issue 5

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

On Fri, Jun 26, 2015 at 11:46 AM, <
dox...@li...> wrote:
>
> Date: Fri, 26 Jun 2015 10:45:54 -0500
> From: woody <kn...@re...>
> Subject: Re: [Doxygen-users] adding doxygen comments to code
> To: Richard Damon <Ri...@Da...>,
>         dox...@li...
> Message-ID: <4.3...@ma...>
> Content-Type: text/plain; charset="us-ascii"
>
> At 01:49 AM 6/26/2015 -0400, Richard Damon <Ri...@Da...
> > wrote:
> >than doxygen itself, and if such a feature was added, having a separate
> >executable makes much more sense to me.
>
> That sounds logical, which is why I said, "have it generate a diff-merge"
> file that can be run through a diff merger.
>

Doxygen can produce and XML file containing the information it extracted
and/or derived from the source files. With out testing, I don't know if
contains any line numbers. (This is intended to be used by "add on" report
generators.)

Anyway,  it should be possible to create a "post processor" that would read
this XML and generate, for example, a set of sed scripts that could insert
comment blocks into copies of your source files.

>  If the default documentation is good enough,
>
> It really isn't.  There are lots of holes that I see so far, including no
> cross reference that gives you all the line numbers where a symbol is
> used.


This is a separate issue. I don't think Doxygen has any option to generate
a cross reference. If it does, Then it certainly should also have an option
to produce it as part of a "document all" operation.


> Especially global variables. I know Doxygen has all the information
> to do that.    Other holes I know Doxygen could fill in with the proper
> headers, but the syntax of the headers is obtuse at best, and would take a
> huge amount of time to manually add to any non-trivial program,.
>
> >you don't need to add the comments to the code to get them (but I think
> >normally you want to go in and improve on them).
>
> yes, but on a multi thousand line code base that would be very expensive in
> terms of time and money.  It seems so logical to have Doxygen be able to
> do it
> for you on a one time basis to get a start.  It baffles me that it
> can't.  It certainly has the information.  It would make it a much more
> complete documentation tool.
>

Because Doxygen doesn't need comments to produce the default documentation,
nobody saw a need to create an "add on" to automatically insert comment
blocks.


> Here is the problem.  The major use case for doxygen is to come in behind
> some guy who wrote a bunch of code, and gain
> some idea of how the code works, so you can maintain it, and create a
> documentation package for it.

...

> Doxygen is most of the way there, but it
> desperately needs a way to be able
> to insert the comments it can generate, into the source.
>

>From looking at the "C Doc" generated comment sample you provided, you
appear to want Doxygen (or an add on to Doxygen) to insert the generated
pieces of documentation into comment blocks before each function, global
variable and other "document-able objects".

A tool to do this (based on information extracted by Doxygen) could
certainly be made.

I would have to do extensive editing to the code to embed the comments
> that doxygen can use to create the documentation correctly.
>

Even after comments blocks are automatically inserted, I would think you
will still have to do extensive editing to include descriptive prose.


> I have yet to get doxygen to do a flow tree, though I have enabled the
> "dot" stuff and have graphviz in the path.  It created flows only
> for certain structures, and those are really not right.
>

Doxygen really only "creates" call graphs and a few other basic
relationship graphs. It was not intended as a source code analyzer.


> I am aware that *IF* you have the right headers, Doxygen can do this and a
> whole lot more.
>

I'm not sure how much of the needed information would (or could) be in
Doxygen's output to create comment blocks with the "fields" needed.
Enhancing Doxygen to generate a cross reference seems reasonably possible.
But, as I said above, Doxygen was not intended to be a source code
analyzer. Output from a proper source code analyzer may also be needed.

Re: [Doxygen-users] adding doxygen comments to code

[woody <kn...@re...>]

At 01:49 AM 6/26/2015 -0400, you wrote:
>Woody,
>I would strongly disagree about adding that functionality directly into 
>doxygen. In its normal usage, it totally should not be changing the source 
>base, and for that to happen with just an option change. The code to add 
>the comment frames into the source files would be a much simpler program 
>than doxygen itself, and if such a feature was added, having a separate 
>executable makes much more sense to me.

That sounds logical, which is why I said, "have it generate a diff-merge" 
file that can be run through a diff merger.

  I'm kind of comparing what the old c-doc did.  For a large program that 
does not have doxygen headers,
it would take a large amount of time to go through and add them.  Doxygen 
*could* create a diff-merge file though pretty easily.
It would not add the comments to the source, just make a file that could be 
run through a diff merger.

Cdoc would do this for you, but it was an option to add the comments to the 
file.  typically you did it once.  As you can see, this was done back
in 2004.  The code is now 11 years old, and this has never been updated, 
primarily because C-Doc isn't around any more.:, secondarily because I
don't have the documentation for the version of C-Doc that I  do have.

Of course, this isn't doxygen compliant, obviously, since doxygen wasn't 
around in the 1980's when C-Doc was first created.

/*FF***********************************************************************
FUNCT: update_intensity                                  2004/09/22 14:29
                                   USERS:
                                          main 

                                          update_current_values 

                                   DEFIN:
                                          INTENSITY_ALLOWED 

                                          INTENSITY_MODIFY 

                                          INTENSITY_OVERIDE 

                                          USER_MAX_INTS 

                                   GLOBL:
                                          control_arrays.intensity_array 

                                          control_arrays.permission 

                                          control_arrays.table_pointer 

                                          control_arrays.table_pointer->intensity_maximum 

                                          control_arrays.table_pointer->intensity_minimum 

                                          control_arrays.table_pointer->intensity_type 

                                          current_intensity 

                                          current_user_intensity 

                                   PARAM:
                                          flags 

                                          next_entry 

                                   LOCAL:
                                          permit 

**************************************************************************/



>I will point out a big reason I don't think you want to do this. Doxygen 
>is fully capable of generating the documentation for objects without the 
>comments being present, and can also generate a list of warning for items 
>that it created documentation without comments.

I have not seen it do any warnings like that todate

>  If the default documentation is good enough,

It really isn't.  There are lots of holes that I see so far, including no 
cross reference that gives you all the line numbers where a symbol is 
used.  Especially global variables. I know Doxygen has all the information 
to do that.    Other holes I know Doxygen could fill in with the proper 
headers, but the syntax of the headers is obtuse at best, and would take a 
huge amount of time to manually add to any non-trivial program,.

>you don't need to add the comments to the code to get them (but I think 
>normally you want to go in and improve on them).

yes, but on a multi thousand line code base that would be very expensive in 
terms of time and money.  It seems so logical to have Doxygen be able to do it
for you on a one time basis to get a start.  It baffles me that it 
can't.  It certainly has the information.  It would make it a much more 
complete documentation tool.


>  Having the undocumented warning is a good way to get a task list of 
> stuff that you want to go in to improve. If you automatically add the 
> comments, the warnings go away and you need to do something else to keep 
> track of what is needed to improve the entries.

I would disagree, once the comments are added, and you have the result, 
then it would be a magnitude easier to tweak them until they were fine.
You could always run it once, and save the warning file, then add the 
comments in.  You can always refer to the warning file to go in and clean 
things up,
but the tool would have saved potentially hundreds of man-hours of time.

Here is the problem.  The major use case for doxygen is to come in behind 
some guy who wrote a bunch of code, and gain
some idea of how the code works, so you can maintain it, and create a 
documentation package for it.

I've been writing code since 1976 for micros, and have made a career as a 
temp.  Ninety percent of the time, I would be coming in to
rescue a project where the original programmer left and/or is not 
contactable (in one case he was in a mental institution, I kid you 
not).  So you take the code, and run it through whatever tools you have so 
you can pick up and go.  Doxygen is most of the way there, but it 
desperately needs a way to be able
to insert the comments it can generate, into the source.  C-Doc doesn't 
exist any more, (though I have an old copy), and no one has the key for the 
newer copy.  Additionally without any kind of manual, it is pretty hard to 
get the options right.

In this case *I* wrote the code over the past 10 years, and now it needs to 
be put in shape so someone coming in can maintain it, cause I'm looking 
retirement in the face.  That and we need to document an architecture for 
IEC 62304 compliance.  (this is code for
a FDA cleared micro-current tens unit).

I would have to do extensive  editing to the code to embed the comments 
that doxygen can use to create the documentation correctly.

I have yet to get doxygen to do a flow tree, though I have enabled the 
"dot" stuff and have graphviz in the path.  It created flows only
for certain structures, and those are really not right.


I have two different structures with a common header.  I have a structure 
that just has the common header.  So I can tell the compiler
to point to the common structure, and information in the common structure 
area will identify which structure it is, so the run time can
know how to handle it.  Yes it is weird, but it solved a batch of 
"incompatible  pointer" problems....

What I have been trying to get it to do is something like this

           -------------[update_parameters]
           |                                |
           |                                --------[calls function 2]
           |                                |____[calls function 2]
           |                                             |____ [calls 
function 4]
           |
main- |
          | ---- [calls button scan]
          |------[calls function 5]
          |

etc.  the editor I use   Source Insight (one of the best editors on the 
planet in my opinion) will do this, but you have to save screen shots.  and 
by the way,
it has a free trial.  This feature is the relationship window.  You can 
have multiple windows, each with a different relationship and when you 
click on a symbol in the code, it will generate a nice graphic for 
you.  Quite impressive.


I am aware that *IF* you have the right headers, Doxygen can do this and a 
whole lot more.



>--
>Richard Damon

Re: [Doxygen-users] adding doxygen comments to code

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

On 6/24/15 12:38 PM, woody wrote:
> 1. I would like to take an undocumented package and have doxygen insert the
> initial documentation into the source file.
> That is, run doxygen on an undocumented package (which I have done)
> and be able to tell doxygen to insert into the SOURCE FILES, the specific
> doxygen headers needed, based on what it figured out.
> is there a way to have doxygen do that?
To my knowledge, doxygen has no facilities to write into the source 
files. It would be a very different sort of utility to do what you are 
looking for.
>
> 2.  It seems to me like doxygen should be able to generate, for each
> variable, a list of line numbers in the code where the variable is
> referenced. I don't see an option for this in the expert section of the wizard.
To my knowledge, doxygen doesn't keep track references to that level of 
detail, and only tracks 'global' items.
>
> 3. since this is an embedded project, the main file has a number of
> interrupt handlers. This is an intensive interrupt driven system.  is there
> a way to make doxygen aware that it should include these interrupt
> functions in the dependency graph, so that the result of graphvis would
> list those as interrupt functions, that interact with
> main.  i.e.   interrupt_function_name with a pointer line to and from main?
>
Interrupt functions really aren't interacting with main, but with the 
whole flow of execution, so drawing their call tree back to main would 
actually be a bit deceptive. Also interrupt functions tend to use some 
implementation specific method of marking them as interrupt functions so 
it is hard for doxygen to identify them, and in some environments there 
is nothing special to mark them, either there is just an array of 
functions pointers used as a vector table (maybe with an assembly 
written wrapper), or a call to a function like setVector with a pointer 
to the function.

-- 
Richard Damon

[Doxygen-users] adding doxygen comments to code

[woody <kn...@re...>]

1. I would like to take an undocumented package and have doxygen insert the 
initial documentation into the source file.
That is, run doxygen on an undocumented package (which I have done)
and be able to tell doxygen to insert into the SOURCE FILES, the specific 
doxygen headers needed, based on what it figured out.
is there a way to have doxygen do that?

2.  It seems to me like doxygen should be able to generate, for each 
variable, a list of line numbers in the code where the variable is 
referenced. I don't see an option for this in the expert section of the wizard.

3. since this is an embedded project, the main file has a number of 
interrupt handlers. This is an intensive interrupt driven system.  is there 
a way to make doxygen aware that it should include these interrupt 
functions in the dependency graph, so that the result of graphvis would 
list those as interrupt functions, that interact with 
main.  i.e.   interrupt_function_name with a pointer line to and from main?

Re: [Doxygen-users] Missing Modules and Namespace Tabs in HTML

[David M. <mor...@um...>]

Albert,

      Thank you very much - that worked perfectly! I particularly
appreciate your generosity in actually trying out doxygen on my code to
find a solution.

-David

On Sat, Jun 20, 2015 at 5:37 AM, Albert <alb...@gm...> wrote:

> David,
>
> In version 1.8.8 (by head) a change has taken place about handling files
> with unknown / unsupported extension. Till that version they were seen as
> C-like files. In version 1.8.8 and up they are skipped, but it is possible
> to use your own extension and map it to a supported version. When I change
> the mapping line to:
>   EXTENSION_MAPPING      = mod=c++ tpp=c++ dox=c++
> I get the namespaces.
>
> You will see some other errors etc as well (e.g. error: the type 'dirs' is
> not supported for the entry tag within a navindex! Check your layout file!)
> so it is advised to have a look at your own layout file as well.
>
> Albert
>
> On Fri, Jun 19, 2015 at 7:00 AM, David Morse <mor...@um...> wrote:
>
>> I recently upgraded doxygen to the most recent version and used the new
>> version
>> to regenerrate html documentation for a C++ project that includes several
>> namespaces
>> and an extensive hierarchy of doxygen modules. The source code for the
>> project, called
>> simpatico, is available at github.com/dmorse/simpatico
>>
>> I find that the html generated by new version generates does not contain
>> the "Modules" or
>> "Namespace" tabs that appeared in html generated by earlier versions. An
>> old version of
>> the documentation generated using doxygen 1.7.6.1, which includes these
>> tabs, is
>> available at <http://dmorse.github.io/simpatico/doc/html/index.html>dmorse.github.io/simpatico/doc/html/index.html
>>
>>
>> I recently upgraded first to 1.8.8 via ubuntu software manager (I am
>> using Ubuntu linux).
>> I had trouble with error messages from sqlite with this version, in
>> addition to the problem
>> described above. In an attempt to fix these problems, I tried upgrading
>> to 1.8.9.1, which
>> I installed by dowloading a tarball of the source code and compiling from
>> source. Both of
>> these recent versions generated a version of html in which the "Modules"
>> and "Namespaces"
>> tabs are absent from the header, though 1.8.9.1 did not generate error
>> messages from
>> sqlite.
>>
>> I did not change anything about the source files, and do not have any
>> clues as to what
>> could cause this change in behavior. I definitely want to retain the
>> missing Modules and
>> Namespace tabs, since these are often the fastest way to navigate to
>> class documentation
>> for a particular class.
>>
>> Does anyone have any ideas regarding the origin of the problem or how it
>> could be
>> fixed?
>>
>> -David
>>
>>
>> ------------------------------------------------------------------------------
>>
>> _______________________________________________
>> Doxygen-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>>
>

Re: [Doxygen-users] Missing Modules and Namespace Tabs in HTML

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

David,

In version 1.8.8 (by head) a change has taken place about handling files
with unknown / unsupported extension. Till that version they were seen as
C-like files. In version 1.8.8 and up they are skipped, but it is possible
to use your own extension and map it to a supported version. When I change
the mapping line to:
  EXTENSION_MAPPING      = mod=c++ tpp=c++ dox=c++
I get the namespaces.

You will see some other errors etc as well (e.g. error: the type 'dirs' is
not supported for the entry tag within a navindex! Check your layout file!)
so it is advised to have a look at your own layout file as well.

Albert

On Fri, Jun 19, 2015 at 7:00 AM, David Morse <mor...@um...> wrote:

> I recently upgraded doxygen to the most recent version and used the new
> version
> to regenerrate html documentation for a C++ project that includes several
> namespaces
> and an extensive hierarchy of doxygen modules. The source code for the
> project, called
> simpatico, is available at github.com/dmorse/simpatico
>
> I find that the html generated by new version generates does not contain
> the "Modules" or
> "Namespace" tabs that appeared in html generated by earlier versions. An
> old version of
> the documentation generated using doxygen 1.7.6.1, which includes these
> tabs, is
> available at <http://dmorse.github.io/simpatico/doc/html/index.html>dmorse.github.io/simpatico/doc/html/index.html
>
>
> I recently upgraded first to 1.8.8 via ubuntu software manager (I am using
> Ubuntu linux).
> I had trouble with error messages from sqlite with this version, in
> addition to the problem
> described above. In an attempt to fix these problems, I tried upgrading to
> 1.8.9.1, which
> I installed by dowloading a tarball of the source code and compiling from
> source. Both of
> these recent versions generated a version of html in which the "Modules"
> and "Namespaces"
> tabs are absent from the header, though 1.8.9.1 did not generate error
> messages from
> sqlite.
>
> I did not change anything about the source files, and do not have any
> clues as to what
> could cause this change in behavior. I definitely want to retain the
> missing Modules and
> Namespace tabs, since these are often the fastest way to navigate to class
> documentation
> for a particular class.
>
> Does anyone have any ideas regarding the origin of the problem or how it
> could be
> fixed?
>
> -David
>
>
> ------------------------------------------------------------------------------
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] Missing Modules and Namespace Tabs in HTML

[David M. <mor...@um...>]

I recently upgraded doxygen to the most recent version and used the new
version
to regenerrate html documentation for a C++ project that includes several
namespaces
and an extensive hierarchy of doxygen modules. The source code for the
project, called
simpatico, is available at github.com/dmorse/simpatico

I find that the html generated by new version generates does not contain
the "Modules" or
"Namespace" tabs that appeared in html generated by earlier versions. An
old version of
the documentation generated using doxygen 1.7.6.1, which includes these
tabs, is
available at <http://dmorse.github.io/simpatico/doc/html/index.html>dmorse.github.io/simpatico/doc/html/index.html


I recently upgraded first to 1.8.8 via ubuntu software manager (I am using
Ubuntu linux).
I had trouble with error messages from sqlite with this version, in
addition to the problem
described above. In an attempt to fix these problems, I tried upgrading to
1.8.9.1, which
I installed by dowloading a tarball of the source code and compiling from
source. Both of
these recent versions generated a version of html in which the "Modules"
and "Namespaces"
tabs are absent from the header, though 1.8.9.1 did not generate error
messages from
sqlite.

I did not change anything about the source files, and do not have any clues
as to what
could cause this change in behavior. I definitely want to retain the
missing Modules and
Namespace tabs, since these are often the fastest way to navigate to class
documentation
for a particular class.

Does anyone have any ideas regarding the origin of the problem or how it
could be
fixed?

-David

Re: [Doxygen-users] Is doxygen.css restricted by GPL?

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

Hi Alan,

> On 15 Jun 2015, at 16:10 , Alan Brogan <Ala...@s3...> wrote:
> 
> Hello the list,Send
> 
> I am scanning commercial source code to ensure that it complies with Open Source licenses. In doing so I have come across a file derived from doxygen.css in what is obviously a directory of documents produced by Doxygen. From the Doxygen overview (http://www.stack.nl/~dimitri/doxygen/manual/index.html) I notice that "Documents produced by doxygen are derivative works derived from the input used in their production; they are not affected by this license".
> 
> It looks like the intention there is that the "documents" are not subject to the GPL, and it applies in a straightforward way to documents primarily derived from "our sources". However the wording becomes problematic when I try to apply it to a file derived from doxygen.css as I can see a number of interpretations which would lead to opposite conclusions:
> 
>     1. *.css are not "Documents" (they're support files), so the exception is void and GPL applies
>     2. The file I found is derived from doxygen.css which is part of the Doxygen project, hence subject to GPL, and that license "carries through" to the output version, so GPL applies.
>     3. The intended effect of this exemption is to allow "the output docs" to be distributed without GPL. The file I found is part of "the output docs", so GPL does not apply
>     4. The file I found is derived from Doxygen, but this exemption removes it from Doxygen's general GPL licensing. In other words: doxygen.css is subject to GPL while part of the Doxygen source, but not subject to it once placed in the output directory. So GPL does not apply.
> 
> So: does the modified doxygen.css have to be distributed under the GPL?

My intention is that doxygen.css is to be considered part of the documentation (so 3 and 4 apply). 

If you want to play really really safe (shouldn't be needed but I'm not a lawyer), 
you can also define a custom style sheet that overrules only the parts doxygen.css that need modification
and use HTML_EXTRA_STYLESHEET to make that delta style sheet part of the documentation set. That way you don't modify doxygen.css and still have
the same end result. An additional benefit is that you are less sensitive to future changes in the stylesheet.

Regards,
  Dimitri

[Doxygen-users] Is doxygen.css restricted by GPL?

[Alan B. <Ala...@s3...>]

Hello the list,Send<https://excork2.cork.s3group.com/owa/?ae=Item&a=New&t=IPM.Note&cc=MTQuMy4yMjQuMixlbi1VUyw0Mjk0OTY3Mjk1LEhUTUwsMCww&pspid=_1434362032279_223517083#>

I am scanning commercial source code to ensure that it complies with Open Source licenses. In doing so I have come across a file derived from doxygen.css in what is obviously a directory of documents produced by Doxygen. From the Doxygen overview (http://www.stack.nl/~dimitri/doxygen/manual/index.html) I notice that "Documents produced by doxygen are derivative works derived from the input used in their production; they are not affected by this license".

It looks like the intention there is that the "documents" are not subject to the GPL, and it applies in a straightforward way to documents primarily derived from "our sources". However the wording becomes problematic when I try to apply it to a file derived from doxygen.css as I can see a number of interpretations which would lead to opposite conclusions:

    1. *.css are not "Documents" (they're support files), so the exception is void and GPL applies
    2. The file I found is derived from doxygen.css which is part of the Doxygen project, hence subject to GPL, and that license "carries through" to the output version, so GPL applies.
    3. The intended effect of this exemption is to allow "the output docs" to be distributed without GPL. The file I found is part of "the output docs", so GPL does not apply
    4. The file I found is derived from Doxygen, but this exemption removes it from Doxygen's general GPL licensing. In other words: doxygen.css is subject to GPL while part of the Doxygen source, but not subject to it once placed in the output directory. So GPL does not apply.

So: does the modified doxygen.css have to be distributed under the GPL?

--
Alan Brogan
Senior Software Configuration Engineer
S3 Group

P.S. While I fully appreciate that a definitive decision on this can only be given at court, I think the opinions of project owners / developers (who I hope read this list) would be helpful to such a court, and certainly helpful to ourselves in our scanning efforts (and fixes after scanning).



-----

The information contained in this e-mail and in any attachments is confidential and is designated solely for the attention of the intended recipient(s). If you are not an intended recipient, you must not use, disclose, copy, distribute or retain this e-mail or any part thereof. If you have received this e-mail in error, please notify the sender by return e-mail and delete all copies of this e-mail from your computer system(s). Please direct any additional queries to: com...@s3.... Thank You. Silicon and Software Systems Limited (S3 Group). Registered in Ireland no. 378073. Registered Office: South County Business Park, Leopardstown, Dublin 18.

[Doxygen-users] Way to use param[out] in xml notation?

[S-TEC A. L. L. <l.l...@s-...>]

Hi, 

I'm documenting a header file with doxygen. On the same time I us Visual
Studio with IntelliSense functionality. This works fine so far. But I need
to mark some parameters as "out". This would be possible with "@param[out]".
Unfortunatly VisualStudio uses xml comments. So is there a way to use the
same feature in xml comments?

Kind regards

Luke

 

[Doxygen-users] Is there a date for the next release of doxygen ?

[Normand <no...@li...>]

Hello Dimitri,
Is there a date for the next release of doxygen ?

-- 
Michel Normand

Re: [Doxygen-users] doxygen build failure for Power8 because double free or corruption

[Normand <no...@li...>]

On 18/03/2015 12:45, Normand wrote:
>
> On 11/03/2015 14:16, Normand wrote:
>> Hi there
>>
>> while building doxygen for opensuse on Power8 guest I hit a failure as detailed in (2)
>> The related backtrace extracted for core file is appended below in (1)
>>
>>
>> === (1)
>> Core was generated by `./bin/doxygen '.
>> Program terminated with signal SIGABRT, Aborted.
>> #0  0x00003fffa5acd194 in __GI_raise (sig=<optimized out>) at ../sysdeps/unix/sysv/linux/raise.c:55
>> 55      ../sysdeps/unix/sysv/linux/raise.c: No such file or directory.
>> Missing separate debuginfos, use: zypper install libgcc_s1-debuginfo-4.8.3+r218481-2.1.ppc64le libstdc++6-debuginfo-4.8.3+r218481-2.1.ppc64le
>> (gdb) bt
>> #0  0x00003fffa5acd194 in __GI_raise (sig=<optimized out>) at ../sysdeps/unix/sysv/linux/raise.c:55
>> #1  0x00003fffa5acf184 in __GI_abort () at abort.c:78
>> #2  0x00003fffa5b136c4 in __libc_message (do_abort=<optimized out>, fmt=<optimized out>) at ../sysdeps/posix/libc_fatal.c:175
>> #3  0x00003fffa5b1ba84 in malloc_printerr (action=<optimized out>, str=0x3fffa5c06b50 "double free or corruption (fasttop)", ptr=<optimized out>) at malloc.c:4960
>> #4  0x00003fffa5b1cadc in _int_free (av=<optimized out>, p=<optimized out>, have_lock=<optimized out>) at malloc.c:3831
>> #5  0x00003fffa5dece10 in operator delete(void*) () from /usr/lib64/libstdc++.so.6
>> #6  0x00000000106620e4 in QGList::takeFirst (this=<optimized out>) at qglist.cpp:628
>> #7  0x000000001053ba84 in dequeue (this=<optimized out>) at ../qtools/qqueue.h:59
>> #8  DotRunnerQueue::dequeue (this=0x1001910fcc0) at dot.cpp:1170
>> #9  0x000000001053bb18 in DotWorkerThread::run (this=0x10019112a50) at dot.cpp:1191
>> #10 0x00000000106a0a44 in QThreadPrivate::start (arg=0x10019112a50) at qthread_unix.cpp:87
>> #11 0x00003fffa5ee9454 in start_thread (arg=0x3fffa38bf180) at pthread_create.c:335
>> #12 0x00003fffa5b9e0c4 in clone () at ../sysdeps/unix/sysv/linux/powerpc/powerpc64/clone.S:96
>> ===
>>
>> (2) https://bugzilla.suse.com/show_bug.cgi?id=921577
>>
>
>
>
> I was able to recreate the problem with doxygen last git commit 1c8bbb6
> *   1c8bbb6 (HEAD, origin/master, origin/HEAD, master) Merge pull request #314
>
> The associated backtrace (from core file) only differ from above by some line numbers
> But is still pointing to same call sequence:
> from DotWorkerThread::run
> to delete in QCollection::Item QGList::takeFirst
> ===
> #0  0x00003fff8433d194 in raise () from /lib64/libc.so.6
> Missing separate debuginfos, use: zypper install glibc-debuginfo-2.21-3.3.ppc64le libgcc_s1-debuginfo-4.8.3+r218481-4.3.ppc64le libstdc++6-debuginfo-4.8.3+r218481-4.3.ppc64le
> (gdb) bt
> #0  0x00003fff8433d194 in raise () from /lib64/libc.so.6
> #1  0x00003fff8433f184 in abort () from /lib64/libc.so.6
> #2  0x00003fff843836c4 in __libc_message () from /lib64/libc.so.6
> #3  0x00003fff8438ba84 in malloc_printerr () from /lib64/libc.so.6
> #4  0x00003fff8438cadc in _int_free () from /lib64/libc.so.6
> #5  0x00003fff8465ce10 in operator delete(void*) () from /usr/lib64/libstdc++.so.6
> #6  0x000000001066c5e4 in QGList::takeFirst (this=<optimized out>) at qglist.cpp:628
> #7  0x0000000010544e04 in dequeue (this=<optimized out>) at ../qtools/qqueue.h:59
> #8  DotRunnerQueue::dequeue (this=0x1001707f7b0) at dot.cpp:1181
> #9  0x0000000010544e98 in DotWorkerThread::run (this=0x1001707efd0) at dot.cpp:1202
> #10 0x00000000106aaf44 in QThreadPrivate::start (arg=0x1001707efd0) at qthread_unix.cpp:87
> #11 0x00003fff84759454 in start_thread () from /lib64/libpthread.so.0
> #12 0x00003fff8440e0c4 in clone () from /lib64/libc.so.6
> ===
>
> The occurence is timing dependent, and there is no failure if trying to start doxygen via gdb or valgrind,
> so I do not know how to continue investigation.
>
> any suggestions are welcome.
>
> ---
> Michel Normand

I did not found the source of the problem,
but found that current master head do not failed anymore:

* with commit id 796d6585be58d1c9112422a919f49d1998dc672c
   I still have the double mfree reported error.
* with commit id 7a0c06d1745739cb7f9753e75cb46f4a431b0eaa
   I do not have any failure.

-- 
Michel Normand

[Doxygen-users] Cross-referencing documantations

[Greisberger C. <gre...@ze...>]

Hi,

I would like to generate the documentation for 2 projects, with cross-references between them.

For example:
+- Project A -+- A.cpp
|             +- A.cfg
|             +- A.tags
|             +- html/
+- Project B -+- B.cpp
              +- B.cfg
              +- B.tags
              +- html/

In A.cfg, I put:
TAGFILES=../Project B/B.tags
OUTPUT_DIRECTORY=.
GENERATE_TAGFILE = A.tags

In B.cfg, I put:
TAGFILES=../Project A/A.tags
OUTPUT_DIRECTORY=.
GENERATE_TAGFILE = B.tags

1. I build the documentation for A.
   It complains about B.tags to be missing, what is normal.
2. I build the documentation for B.
   No warning this time.
3. I rebuild the documentation for A to cross-reference B.

But there I have an error:
A.cpp:36: warning: the name 'Project A/A.cpp' supplied as the second argument in the \file statement matches the following input files:
  Project A/A.cpp
  Project B/B.tags:Project A/A.cpp

Is it possible to do bidirectional cross-references between 2 documentations, or is it forbidden?
Perhaps did I miss an option in the configuration file?
Did anyone faced this problem before?

Thanks.

Re: [Doxygen-users] Graph on Doxygen

[Live \(jamiil\) <ja...@li...>]

# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
# each documented class showing the direct and indirect inheritance relations.
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.

CLASS_GRAPH            =  YES

From: Moshe Bublil 
Sent: Monday, June 8, 2015 6:33 PM
To: dox...@li... 
Subject: [Doxygen-users] Graph on Doxygen

I am not able to see the graph dependencies  after I run doxygen 

I download graphviz 


-- 

Moshe Bublil | V.P R&D  Engineering

Rachip Ltd 


mo...@ra...
Tel:                  +972 74 718400
Fax:                 +972 74-7184030
Cell:                 +972 54 9222288
www.rachip.com



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



--------------------------------------------------------------------------------
_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Confusion between documentation of function and inner class

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

Doxygen 1.8.7

In a class, I have a function within which an inner class is declared.

//*! This is a test class
*/
class TestClass {

/*! \brief A function which does something
/*  \param param_A this is the first parameter of doSomething function
/*  \param param_B this is the second parameter of doSomething function 
 */
void doSomething(int param_A, int param_B) {

/*! This is an inner Test Class
*/
class InnerTestClass {

/*! \brief A constructor for InnerTestClass
 *  \param param_C this is the parameter for the InnerTestClass inner class
constructor
 */
InnerTestClass (int param_C) {

}

}
/

When I generate the doxygen documentation for the above class, a confusion
occurs between the documentation for the function doSomething and the inner
class InnerTestClass. 

1. No inner class documentation file called classInnerTestClass.html is
created.
2. In the documentation for classTestClass.html, the documentation for the
InnerTestClass is included with the documentation for the function, as
follows:

/doSomething(int param_A
	    int param_B
	    )

A function which does something

Parameters
	param_A		this is the first parameter of doSomething function
	param_B		this is the second parameter of doSomething function 

This is an inner Test Class

Parameters
	param_C		this is the parameter for the InnerTestClass inner class
constructor/

3. Warning messages are shown indicating that param_A and param_B are not
documented and that param_C is not found in the argument list of
doSomething.
	



--
View this message in context: http://doxygen.10944.n7.nabble.com/Confusion-between-documentation-of-function-and-inner-class-tp7208.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] How to output the declarations only of extern C functions

[Jeremy R. <jro...@gm...>]

Perhaps this question has been answered already - I'm more or less a 
Doxygen beginner. I looked through the config parameters, and saw 
nothing suitable.
I have a C program with about 25 modules. Using the default 
configuration, each module documentation contains the whole 
documentation of every external function. One thus gets a description of 
the function in every module which calls the function.
Is it possible to  output just the declaration, and have a reference to 
the complete function? This would make the documentation more compact
Thanks for a great program
Jerry

[Doxygen-users] unsubscription

[Aketh TM <ake...@gm...>]

HI,

Can you unsbscribe me by any chance.

Regards,
Aketh T. M

[Doxygen-users] Graph on Doxygen

[Moshe B. <mo...@ra...>]

I am not able to see the graph dependencies  after I run doxygen

I download graphviz

-- 

*Moshe Bublil | V.P R&D  Engineering*

*Rachip Ltd*

mo...@ra... <ra...@ra...>
Tel:                  +972 74 718400
Fax:                 +972 74-7184030
Cell:                 +972 54 9222288
www.rachip.com

[Doxygen-users] Sql documentation

[anagno <ana...@ho...>]

Hi to all,

I was wondering if there is a way to document sql with doxygen.

Thank you in advance

anagno



--
View this message in context: http://doxygen.10944.n7.nabble.com/Sql-documentation-tp7204.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...>]

H Diarmuid,

Sorry for the slow response.

When I put the lines:
/** Docu namespace
*/

above the namespace line I get the namespace documentation, but you are
right the "More" is still not working (Well actually it is working, but
pointing to itself instead of pointing to the documentation in the
namespace).

Actual question might even be should the function be documented on files
page of TestHelpMe.h or should it only be documented on the namespace page.

Albert


On Mon, Jun 1, 2015 at 10:46 AM, didje <dia...@pd...> wrote:

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