doxygen-users — List for users of doxygen

[Doxygen-users] Question about documenting C++11 "using" statements

[David B. <dav...@ic...>]

Hello doxygen folks,

In C++11, I have a base class with public methods and a derived class, in which I would like to hide some of the base class members and expose some of the base class members. In C++, this is easy to do by making the base class private to the derived class, and using a “using” statement in the public section of the derived class to expose the private method. The compiler is fine with this, but figuring out how doxygen this approach seems impossible.

Can you give me any advice?

Code snippet below:

/**
 * @brief This is the brief for class A.
 */
class A {
public:
		/// Brief for a_method
		// @param[in] x The first parameter.
		void a_method(int x)	
		{
		}
};

/**
 * @brief This is the brief for class B.
 */
class B : private A {
public:
		/// Brief for the a_method
		// Want documentation or at least link for A::a_method to appear in B's html page.
		// No clue how to do it without declaring a B::a_method that calls A::a_method, and using copydoc.
		using A::a_method;
};

Re: [Doxygen-users] [Pure C] Global variables in call graph

[Xenia G. <lin...@gm...>]

Thanks for the idea!

2017-03-21 19:15 GMT+02:00 Richard Damon <Ri...@da...>:
> You can make a function you call to access them! Make the function inline, and it will likely not even cost you any time/space in the program. Maybe even uglify the global variable name so you change all the references to use the accessor function.
>
>> On Mar 21, 2017, at 9:13 AM, Xenia Galinskaya <lin...@gm...> wrote:
>>
>> OK, is it possible to add global variable names to call graph, somehow?
>>
>> 2017-03-21 11:22 GMT+02:00 Christoph Lipka <chr...@li...>:
>>>> Am 21.03.2017 um 08:42 schrieb Xenia Galinskaya:
>>>> I've a program with lots of global variables, but they are absent in
>>>> call graphs.
>>>>
>>>> Is it possible to show them in CG?
>>>
>>> It's a call graph. It only shows stuff that is called.
>>> You don't "call" global variables. You just access them.
>>>
>>> ------------------------------------------------------------------------------
>>> 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
>>
>>
>>
>> --
>> С уважением,
>> Ксения Галинская.
>>
>> (068) 387 3617
>>
>> ------------------------------------------------------------------------------
>> 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
>



-- 
С уважением,
Ксения Галинская.

(068) 387 3617

Re: [Doxygen-users] [Pure C] Global variables in call graph

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

You can make a function you call to access them! Make the function inline, and it will likely not even cost you any time/space in the program. Maybe even uglify the global variable name so you change all the references to use the accessor function.

> On Mar 21, 2017, at 9:13 AM, Xenia Galinskaya <lin...@gm...> wrote:
> 
> OK, is it possible to add global variable names to call graph, somehow?
> 
> 2017-03-21 11:22 GMT+02:00 Christoph Lipka <chr...@li...>:
>>> Am 21.03.2017 um 08:42 schrieb Xenia Galinskaya:
>>> I've a program with lots of global variables, but they are absent in
>>> call graphs.
>>> 
>>> Is it possible to show them in CG?
>> 
>> It's a call graph. It only shows stuff that is called.
>> You don't "call" global variables. You just access them.
>> 
>> ------------------------------------------------------------------------------
>> 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
> 
> 
> 
> -- 
> С уважением,
> Ксения Галинская.
> 
> (068) 387 3617
> 
> ------------------------------------------------------------------------------
> 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] [Pure C] Global variables in call graph

[Xenia G. <lin...@gm...>]

OK, is it possible to add global variable names to call graph, somehow?

2017-03-21 11:22 GMT+02:00 Christoph Lipka <chr...@li...>:
> Am 21.03.2017 um 08:42 schrieb Xenia Galinskaya:
>> I've a program with lots of global variables, but they are absent in
>> call graphs.
>>
>> Is it possible to show them in CG?
>
> It's a call graph. It only shows stuff that is called.
> You don't "call" global variables. You just access them.
>
> ------------------------------------------------------------------------------
> 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



-- 
С уважением,
Ксения Галинская.

(068) 387 3617

Re: [Doxygen-users] [Pure C] Global variables in call graph

[Christoph L. <chr...@li...>]

Am 21.03.2017 um 08:42 schrieb Xenia Galinskaya:
> I've a program with lots of global variables, but they are absent in
> call graphs.
> 
> Is it possible to show them in CG?

It's a call graph. It only shows stuff that is called.
You don't "call" global variables. You just access them.

[Doxygen-users] [Pure C] Global variables in call graph

[Xenia G. <lin...@gm...>]

I've a program with lots of global variables, but they are absent in
call graphs.

Is it possible to show them in CG?

[Doxygen-users] C++: brief comments

[Sebastien <seb...@in...>]

Hello,

I have recently updated Doxygen from 1.8.11 to 1.8.14... and the number of
warnings in my project has skyrocketed with it (from 0 to almost 5000...)

I use Doxygen with EXTRACT_ALL=YES and WARN_NO_PARAMDOC =YES.

The issue stems from one liner functions or methods, for instance I might
have:

//! Get the current value of foo.
const Foo& GetFoo() const noexcept;

Previously it returned no warning, but now it's complaining about the
missing documentation about the return type (and it's worse if some
parameters are involved).

I could correct and replace by:

/*!
 * \brief Accessor to the current value of foo.
 *
 * \return Current value of foo.
 */
const Foo& GetFoo() const noexcept;

but it would be very cumbersome... and it hinders readability, because the
header files would become much bigger.

Choosing WARN_NO_PARAMDOC=NO would on the other hand hide real missing
documentation in more elaborated functions or methods.

Is there a way to make the one-liner comment enough without raising any
warning?

Thanks!

Best regards,

Sébastien







--
View this message in context: http://doxygen.10944.n7.nabble.com/C-brief-comments-tp7819.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Include relations, directory graph and indirect dependencies

[Jeremy M. <jm...@4d...>]

Hi,

I created a directory graph in the hope of capturing all the physical dependencies, direct and indirect, for a particular program, but it only has direct dependencies. Some of those direct dependencies have a red border where there are more indirect dependencies. Is it possible to generate a directory graph with those expanded in order to see everything in one graph?

On a related note, the clustering of modules within a top-level project directory seems a bit weird. Say I have a project directory Foo with modules A and B, then the directory dependency graph for Foo has A and B within Foo, as expected. But when I do a directory dependency graph of A, it shows A inside Foo, but shows B outside of Foo, which is unexpected and even seems wrong. Do I have the wrong expectation or is this misbehaviour?

I’m using 1.8.9.1 by the way.
Thanks, cheers.

Jeremy Murphy | Software Engineer
4Dx Limited
E | jm...@4d...<mailto:jm...@4d...> W | 4dx.com<http://www.4dx.com/> P | +61 3 9545 5940

NOTICE: This e-mail and any files transmitted with it are CONFIDENTIAL and are only for the use of the person/s to whom they are addressed. If you are not the intended recipient and/or you have received this email in error, then any use, dissemination, forwarding, printing, copying or dealing in any way whatsoever with this email is strictly prohibited. If you have received this email in error, please reply immediately by way of advice to us and delete or destroy all copies of this e-mail and any file transmitted with it. It is the addressee/recipient duty to virus scan and otherwise test the information provided before loading onto any computer system. Neither 4Dx Ltd nor the sender warrants that the information is free of a virus or any other defect or error. Any views expressed in this message are those of the individual sender, except where the sender specifically states them to be the views of 4Dx Ltd.

Re: [Doxygen-users] Unexpected tag `anchor` found in struct compound in tagfile

[John G. <jg....@gm...>]

I still don't understand what's going on here.

I made a small example that displays this issue's behaviour in a Github
repo, it should be reproducible, and the README gives (AFAIK) all the info
needed to understand the situation.

https://github.com/trosh/doxygen-struct-anchor-issue

Here's a copy of the README:

This is a pair of fake C projects, *low* and *high*, with *high* depending
on *low*. They each have a header file, which has a typedef to a struct and
a typedef to a pointer to that (all of this documented).

/** ... */
typedef struct {...} OBJECT_s;
/** ... */
typedef OBJECT_s * OBJECT_p;

That is not necessarily a practice I particularly condone, but valid C
nontheless.

Doxyfiles and Makefiles have been provided to generate the documentation
and tagfile for *low*, and the documentation for *high* using *low*'s
tagfile.

A simple call to make in this repo's root will make both docs, and should
hopefully reproduce the warning I am trying to understand / avoid / fix
when building the *high* doc.

low/doxygen.tag:26: warning: Unexpected tag `anchor' found

The mentioned line is the following:

23  <compound kind="struct">
24    <name>object</name>
25    <filename>low_8h.html</filename>
26    <anchor>structobject</anchor>    <!-- CULPRIT LINE -->
27    <member kind="variable">
28      <type>int</type>
29      <name>val</name>
30      <anchorfile>low_8h.html</anchorfile>

To see how the Doxyfiles were made, I included references (made with doxygen
-g) and the differences can be displayed with a simple call to make
Doxyfile-diff which will call diff in both projects.

For info, these are the relevant changes at the time of writing this :

make -C low  Doxyfile-diff

> INLINE_SIMPLE_STRUCTS  = YES
> INPUT                  = .
> GENERATE_LATEX         = NO
> GENERATE_TAGFILE       = doxygen.tag

make -C high Doxyfile-diff

> INPUT                  = .
> GENERATE_LATEX         = NO
> TAGFILES               = ../low/doxygen.tag=../../low/html




Thanks for reading, and I really hope someone can shed some light into
what's going on :-)

> --
John Gliksberg
M2 MIHPS @ UVSQ
mobile : +33.6.40.60.76.95

Re: [Doxygen-users] ghost references by function (doxygen 1.8.13)

[Jan R. <jan...@co...>]

Hi

The problem seems to be related to a combination of group, namespace and function definition.

See attached tgz.
The a.cpp and c.cpp behave normally as expected.
The c.cpp links functions to each other even when they have any calls in their body.

The difference between b.cpp and c.cpp
Is syntax of function definition

    int
    aa::
    a1 (void)

   triggers the issue (I know that it is not usual syntax, but source code can't be changed at this moment)

vs.

    int aa::a1 (void)

   behaves as expected.

Thanks for any help.
Jan

From: Jan Ruzicka
Sent: Thursday, March 09, 2017 12:29 PM
To: 'dox...@li...' <dox...@li...>
Subject: RE: ghost references by function (doxygen 1.8.13)

Hi

The References section seems to always include a next function.

Jan

From: Jan Ruzicka
Sent: Thursday, March 09, 2017 11:38 AM
To: 'dox...@li...' <dox...@li...>
Subject: ghost references by function (doxygen 1.8.13)

Hi

Does anybody else see ghost links in references sections?
Doxygen version 1.8.13.

"References" section of function documentation have functions that are not called in the documented function at all.
In example below, function just assigns values, but references has xxx::yyy::fatal_exit().

Sorry, I don't have a nice small self-contained  test case.

Jan

[1] Example of doxygen output:
get_versions()
void xxx::yyy::get_versions           (              int &      major_,
                              int &      minor_,
                              int &      micro_
               )

Get the version numbers for this module.

Parameters
    major_             The major version number.
    minor_             The minor version number.
    micro_             The micro version number.

Returns
    void.

Definition at line 80 of file tools.cpp.

References xxx::yyy::fatal_exit().

Referenced by xxx::yyy::check_args().
{
     major_ = MAJOR_VERSION;
     minor_ = MINOR_VERSION;
     micro_ = MICRO_VERSION;
}


Jan Ruzicka
Senior Software Engineer
Comtech Mobile Datacom Corporation
20430 Century Blvd, Germantown, MD 20874
Office: 240-686-3300
Fax: 240-686-3301

The information contained in this message may be privileged and/or confidential. If you are not the intended recipient, or responsible for delivering this message to the intended recipient, any review, forwarding, dissemination, distribution or copying of this communication or any attachment(s) is strictly prohibited. If you have received this message in error, please so notify the sender immediately, and delete it and all attachments from your computer and network.


________________________________

NOTICE TO RECIPIENT: This email, including attachments, may contain information which is confidential, proprietary, attorney-client privileged and/or controlled under U.S. export laws and regulations and may be restricted from disclosure by applicable State and Federal law. Nothing in this email shall create any legal binding agreement between the parties unless expressly stated herein and provided by an authorized representative of Comtech Telecommunications Corp. or its subsidiaries. If you are not the intended recipient of this message, be advised that any dissemination, distribution, or use of the contents of this message is strictly prohibited. If you received this message in error, please notify us immediately by return email and permanently delete all copies of the original email and any attached documentation from any computer or other media.

Re: [Doxygen-users] Hyperlinked PDF generation has broken in verson 1.8.13

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

Igor,

Hard to tell from just the snippet from the LaTeX file I think the log file
might contain some more information about the files being processed. Maybe
you can find the problematic file from this and try to generation just for
the source file belonging to this LaTeX file and come to a small example
that ypou cans share.

Albert

On Thu, Mar 9, 2017 at 1:52 PM, Igor Rudenko <iru...@cl...> wrote:

> Hello.
>
> After switching to Doxygen version 1.8.13 generation of hyperlinked PDF
> through LaTeX has broken for my project. I'm not LaTeX expert so
> unfortunately, the error message below looks unclear for me
>
> [87
> ! pdfTeX error (ext4): \pdfendlink ended up in different nesting level
> than \pd
> fstartlink.
> \AtBegShi@Output ...ipout \box \AtBeginShipoutBox
>                                                   \fi \fi
> l.50  \}\begin{DoxyCompactList}\small\item\em
>
> \hyperlink{structsmartdata2_1_...
>
> !  ==> Fatal error occurred, no output PDF file produced!
>
> I would be appreciated for any ideas how to find the cause of error.
>
> ------------------------------------------------------------
> ------------------
> Announcing the Oxford Dictionaries API! The API offers world-renowned
> dictionary content that is easy and intuitive to access. Sign up for an
> account today to start using our lexical data to power your apps and
> projects. Get started today and enter our developer competition.
> http://sdm.link/oxford
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

Re: [Doxygen-users] ghost references by function (doxygen 1.8.13)

[Jan R. <jan...@co...>]

Hi

The References section seems to always include a next function.

Jan

From: Jan Ruzicka
Sent: Thursday, March 09, 2017 11:38 AM
To: 'dox...@li...' <dox...@li...>
Subject: ghost references by function (doxygen 1.8.13)

Hi

Does anybody else see ghost links in references sections?
Doxygen version 1.8.13.

"References" section of function documentation have functions that are not called in the documented function at all.
In example below, function just assigns values, but references has xxx::yyy::fatal_exit().

Sorry, I don't have a nice small self-contained  test case.

Jan

[1] Example of doxygen output:
get_versions()
void xxx::yyy::get_versions           (              int &      major_,
                              int &      minor_,
                              int &      micro_
               )

Get the version numbers for this module.

Parameters
    major_             The major version number.
    minor_             The minor version number.
    micro_             The micro version number.

Returns
    void.

Definition at line 80 of file tools.cpp.

References xxx::yyy::fatal_exit().

Referenced by xxx::yyy::check_args().
{
     major_ = MAJOR_VERSION;
     minor_ = MINOR_VERSION;
     micro_ = MICRO_VERSION;
}


Jan Ruzicka
Senior Software Engineer
Comtech Mobile Datacom Corporation
20430 Century Blvd, Germantown, MD 20874
Office: 240-686-3300
Fax: 240-686-3301

The information contained in this message may be privileged and/or confidential. If you are not the intended recipient, or responsible for delivering this message to the intended recipient, any review, forwarding, dissemination, distribution or copying of this communication or any attachment(s) is strictly prohibited. If you have received this message in error, please so notify the sender immediately, and delete it and all attachments from your computer and network.


________________________________

NOTICE TO RECIPIENT: This email, including attachments, may contain information which is confidential, proprietary, attorney-client privileged and/or controlled under U.S. export laws and regulations and may be restricted from disclosure by applicable State and Federal law. Nothing in this email shall create any legal binding agreement between the parties unless expressly stated herein and provided by an authorized representative of Comtech Telecommunications Corp. or its subsidiaries. If you are not the intended recipient of this message, be advised that any dissemination, distribution, or use of the contents of this message is strictly prohibited. If you received this message in error, please notify us immediately by return email and permanently delete all copies of the original email and any attached documentation from any computer or other media.

[Doxygen-users] ghost references by function (doxygen 1.8.13)

[Jan R. <jan...@co...>]

Hi

Does anybody else see ghost links in references sections?
Doxygen version 1.8.13.

"References" section of function documentation have functions that are not called in the documented function at all.
In example below, function just assigns values, but references has xxx::yyy::fatal_exit().

Sorry, I don't have a nice small self-contained  test case.

Jan

[1] Example of doxygen output:
get_versions()
void xxx::yyy::get_versions           (              int &      major_,
                              int &      minor_,
                              int &      micro_
               )

Get the version numbers for this module.

Parameters
    major_             The major version number.
    minor_             The minor version number.
    micro_             The micro version number.

Returns
    void.

Definition at line 80 of file tools.cpp.

References xxx::yyy::fatal_exit().

Referenced by xxx::yyy::check_args().
{
     major_ = MAJOR_VERSION;
     minor_ = MINOR_VERSION;
     micro_ = MICRO_VERSION;
}


Jan Ruzicka
Senior Software Engineer
Comtech Mobile Datacom Corporation
20430 Century Blvd, Germantown, MD 20874
Office: 240-686-3300
Fax: 240-686-3301
The information contained in this message may be privileged and/or confidential. If you are not the intended recipient, or responsible for delivering this message to the intended recipient, any review, forwarding, dissemination, distribution or copying of this communication or any attachment(s) is strictly prohibited. If you have received this message in error, please so notify the sender immediately, and delete it and all attachments from your computer and network.


________________________________

NOTICE TO RECIPIENT: This email, including attachments, may contain information which is confidential, proprietary, attorney-client privileged and/or controlled under U.S. export laws and regulations and may be restricted from disclosure by applicable State and Federal law. Nothing in this email shall create any legal binding agreement between the parties unless expressly stated herein and provided by an authorized representative of Comtech Telecommunications Corp. or its subsidiaries. If you are not the intended recipient of this message, be advised that any dissemination, distribution, or use of the contents of this message is strictly prohibited. If you received this message in error, please notify us immediately by return email and permanently delete all copies of the original email and any attached documentation from any computer or other media.

[Doxygen-users] Hyperlinked PDF generation has broken in verson 1.8.13

[Igor R. <iru...@cl...>]

Hello.

After switching to Doxygen version 1.8.13 generation of hyperlinked PDF
through LaTeX has broken for my project. I'm not LaTeX expert so
unfortunately, the error message below looks unclear for me

[87
! pdfTeX error (ext4): \pdfendlink ended up in different nesting level than
\pd
fstartlink.
\AtBegShi@Output ...ipout \box \AtBeginShipoutBox
                                                  \fi \fi
l.50  \}\begin{DoxyCompactList}\small\item\em

\hyperlink{structsmartdata2_1_...

!  ==> Fatal error occurred, no output PDF file produced!

I would be appreciated for any ideas how to find the cause of error.

[Doxygen-users] Undocumented feature: ParamArrays in PHP

[Willem B. <w-...@dd...>]

In PHP, you can use the func_get_args() function to read all the
parameters to a function or method. This can be used to build functions
that accept any number of parameters, like the ParamArray construct in
languages like Visual Basic.

When I was looking for a way to document such a construct in Doxygen, I
could not find it in the documentation. However, I found a way to do it
in PHPCodumentor, and I bluntly tried that in Doxygen. And it worked!

If you append ",..." to a parameter name in PHP, Doxygen will produce
the right output and there is no warning it cannot find that appended
parameter. For example:


/// @brief select values immediately.
/// @details Any preselected keys are also selected,
/// This allows values to be requested in batches.
/// @param[in] mixed $mixKeyValue,... The key of the record to schedule.
/// May by used as ParamArray.
 public function Select($mixKeyValue=NULL)
       {}


It would be nice it this feature could be included in the documentation
as well.

Best regards,

Willem Bogaerts.

[Doxygen-users] Rename "Classes" navigation element in HTML

[Stephan D. <ste...@gm...>]

Dear List,

I'm using Doxygen to document Java and generate HTML for the API
documentation.

I'd like to rename the "Classes" 'category' (or 'page' rather), the one
containing Class List, Class Hierarchy, etc.

Is there a way to achieve this?

Many thanks!
Stephan

[Doxygen-users] A bug in Doxygen parser?

[Libor B. <buk...@fe...>]

Hi,


I have encountered the problem with the Doxygen parser for the following 
code:

// HEADER FILE: 'test.h'

#ifndef HLIDAC_PES_TEST_H
#define HLIDAC_PES_TEST_H

#include <vector>
#include <utility>

struct T {
         void f(const std::vector<void*>& v);
         void f(const std::pair<double, double>& p);
};

#endif

// SOURCE FILE: 'test.cpp'
#include "test.h"

using namespace std;

void T::f(const vector<void*>& v)       { }

void T::f(const pair<double, double>& p) { }


If you generate the documentation (BUILTIN_STL_SUPPORT is set to YES), 
then you get the following warning:

Searching for member function documentation...
.../test/test.cpp:7: warning: no matching class member found for
   void T::f(const pair< double, double > &p)
Possible candidates:
   void T::f(const std::vector< void *> &v)
   void T::f(const std::pair< double, double > &p)

The problem does not occur if:

- The namespace 'std' is explicitly stated in cpp file.

- If overloading is not used, i.e. each function has a different name.


Questions:

Is there a way how to deal with this issue without being inconsistent?

Is this a real bug or warning can be ignored?


Thank you for your help,

best regards, Libor Bukata.

[Doxygen-users] Refer to a parameter inside documentation

[José L. G. P. <jgp...@gm...>]

Hello:

I have a documentation of the tipe

/**
\param[in] parameter1 Blahblahbla
\param[in] parameter2 This parameter should be greater than \em parameter1
*/

Usually I use to refer to a parameter inside documentation with the
tag \em, \p or \a. I searched about any command in order to refer a
parameter. I think there is no one that produces an html link to the
parameter. Well, but I would like that the reference to parameter1
would have the same appearance (font and colour) as the parameter
printed for \param[in] parameter1, \param[in] parameter12, etc. (in my
case s a kind of bold dark red). Is there a such command?

Thanks

-- 
*****************************************
José Luis García Pallero
jgp...@gm...
(o<
/ / \
V_/_
Use Debian GNU/Linux and enjoy!
*****************************************

[Doxygen-users] Latex output for use as part of another document

[Protsenko, A. <and...@ha...>]

Hi everyone,
Is it possible to generate LaTeX code of the documentation that I could put as an appendix to my thesis and compile together with it?

Thanks for help

[Doxygen-users] Group projects by folders

[Protsenko, A. <and...@ha...>]

Hello everybody,
I several projects in sperate folders (a library and applications that use it) that I would like to document together as separate modules. Is  it possible to have them grouped or I have to manually add every file to a froup? also what is the difference between \ingroup and \addtogroup?

thanks for help

Re: [Doxygen-users] Install and use in a company computer

[Quietlake <hao...@mi...>]

Thanks, Rob Boehne.

The history helps me a lot.

I also try to study more resources. I think I understand GPL and FOSS much
more.


source:
1. https://www.gnu.org/licenses/gpl-faq.html
2. https://copyleft.org/guide/comprehensive-gpl-guidech13.html



--
View this message in context: http://doxygen.10944.n7.nabble.com/Install-and-use-in-a-company-computer-tp7796p7800.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Install and use in a company computer

[Rob B. <ro...@da...>]

Gabriel,

If you understand the history behind the GPL it¹s a bit easier to
understand it¹s stipulations.  The point is really to prevent a company
from taking the source code, modifying it and selling it without granting
access to the modified source code.  This is how Microsoft added
networking into Windows, by copying code from BSD and selling it (without
source), which would not be legal under the GPL.

If your company doesn¹t use a modified version of Doxygen, you have no
obligations to worry about.  If any bugs you fix are fixed through the
main project, you are also good from the legal perspective, and aligned
with the spirit of FOSS.

HTH,

Robert Boehne


On 2/15/17, 10:06 PM, "Quietlake" <hao...@mi...> wrote:

>Thanks, jo3w4rd.
>
>Before I ask the question, I know the Doxygen using the GPL license .
>I try my best to understand GPL, but still confused.
>Based on following data found on GPL website, I could install and use
>Doxygen in a company computer without any fee. Is that correct?
>
>Is making and using multiple copies within one organization or company
>³distribution²? (#InternalDistribution)
>No, in that case the organization is just making the copies for itself.
>As a
>consequence, a company or other organization can develop a modified
>version
>and install that version through its own facilities, without giving the
>staff permission to release that modified version to outsiders.
>
>However, when the organization transfers copies to other organizations or
>individuals, that is distribution. In particular, providing copies to
>contractors for use off-site is distribution.
>
>Gabriel
>
>
>
>--
>View this message in context:
>http://doxygen.10944.n7.nabble.com/Install-and-use-in-a-company-computer-t
>p7796p7798.html
>Sent from the Doxygen - Users mailing list archive at Nabble.com.
>
>--------------------------------------------------------------------------
>----
>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] Install and use in a company computer

[Quietlake <hao...@mi...>]

Thanks, jo3w4rd.

Before I ask the question, I know the Doxygen using the GPL license .
I try my best to understand GPL, but still confused.
Based on following data found on GPL website, I could install and use
Doxygen in a company computer without any fee. Is that correct?

Is making and using multiple copies within one organization or company
“distribution”? (#InternalDistribution)
No, in that case the organization is just making the copies for itself. As a
consequence, a company or other organization can develop a modified version
and install that version through its own facilities, without giving the
staff permission to release that modified version to outsiders.

However, when the organization transfers copies to other organizations or
individuals, that is distribution. In particular, providing copies to
contractors for use off-site is distribution.

Gabriel



--
View this message in context: http://doxygen.10944.n7.nabble.com/Install-and-use-in-a-company-computer-tp7796p7798.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Install and use in a company computer

[Joe W. <bro...@ya...>]

Well, the license for Doxygen is right on its website: http://www.stack.nl/~dimitri/doxygen/ <http://www.stack.nl/~dimitri/doxygen/>

> On Feb 15, 2017, at 18:22, Quietlake <hao...@mi...> wrote:
> 
> Hi,
> 
> I would like to use Doxygen for documentation in a C# project in my company.
> 
> The purpose is to generate documentations which only used by our development
> team.
> 
> I would like to know is it "free" to install and use Doxygen in a company
> computer?
> 
> If the answer is Yes, could anyone provide a certification mention it is
> free to install and use in a company computer.
> 
> Greetings,
> Gabriel
> 
> 
> 
> --
> View this message in context: http://doxygen.10944.n7.nabble.com/Install-and-use-in-a-company-computer-tp7796.html
> Sent from the Doxygen - Users mailing list archive at Nabble.com.
> 
> ------------------------------------------------------------------------------
> 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] Install and use in a company computer

[Quietlake <hao...@mi...>]

Hi,

I would like to use Doxygen for documentation in a C# project in my company.

The purpose is to generate documentations which only used by our development
team.

I would like to know is it "free" to install and use Doxygen in a company
computer?

If the answer is Yes, could anyone provide a certification mention it is
free to install and use in a company computer.

Greetings,
Gabriel



--
View this message in context: http://doxygen.10944.n7.nabble.com/Install-and-use-in-a-company-computer-tp7796.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.