www-legal-discuss mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Henri Yandell (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (LEGAL-224) Can Apache projects use Doxygen-generated config files?
Date Tue, 23 Feb 2016 04:20:18 GMT

    [ https://issues.apache.org/jira/browse/LEGAL-224?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15158255#comment-15158255
] 

Henri Yandell edited comment on LEGAL-224 at 2/23/16 4:19 AM:
--------------------------------------------------------------

(per version 1.7.6.1)

Running doxygen -g, you get a Doxyfile file that can be characterized as:

1781 lines of comments and key=value pairs, consisting of:
  1053 lines of comment.
  491 blank lines.
  237 key=value pairs.

The keys are required variables as understood by Doxygen.
The values are single word literals, outside of a default project name of "My Project" (which
would be changed) and a descriptive name for the docs of 'Doxygen generated docs'. 

I will propose to legal-discuss@ that this be resolved as:

Qn: Can Apache projects use Doxygen-generated config files?
Ans: Providing the generated comments are removed from the files, these files may be used.





was (Author: bayard):
(per version 1.7.6.1)

Running doxygen -g, you get a Doxyfile file that can be characterized as:

1781 lines of comments and key=value pairs, consisting of:
  1053 lines of comment.
  491 blank lines.
  237 key=value pairs.

The keys are required variables as understood by Doxygen.
The values are single word variables, outside of a default project name of "My Project" (which
would be changed) and a descriptive name for the docs of 'Doxygen generated docs'. 

I will propose to legal-discuss@ that this be resolved as:

Qn: Can Apache projects use Doxygen-generated config files?
Ans: Providing the generated comments are removed from the files, these files may be used.




> Can Apache projects use Doxygen-generated config files?
> -------------------------------------------------------
>
>                 Key: LEGAL-224
>                 URL: https://issues.apache.org/jira/browse/LEGAL-224
>             Project: Legal Discuss
>          Issue Type: Task
>            Reporter: Ryan Blue
>
> Avro uses Doxygen to generate C# and C++ documentation. Doxygen is configured by [a "Doxyfile"|https://github.com/apache/avro/blob/trunk/lang/c++/Doxyfile]
that appears to have been generated from [a GPL licensed doc within Doxygen|https://github.com/doxygen/doxygen/blob/master/src/config.xml]
and then changed for the needs of the project. Can Avro use this Doxyfile, or should the project
create a new Doxyfile with only the configuration options it needs and none of the comments
from the configuration template?
> I should also note that while the source file has a GPL license header, the Doxyfile
does not.
> Several other projects appear to use a similar Doxyfile, like [ORC|https://github.com/apache/orc/blob/master/c%2B%2B/Doxyfile]
and [Celix|https://github.com/apache/celix/blob/master/Doxyfile.in].



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: legal-discuss-unsubscribe@apache.org
For additional commands, e-mail: legal-discuss-help@apache.org


Mime
View raw message