Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BUILD_DOCS, ENABLE_DOXYGEN #59

Closed
nschloe opened this issue May 20, 2014 · 4 comments
Closed

BUILD_DOCS, ENABLE_DOXYGEN #59

nschloe opened this issue May 20, 2014 · 4 comments

Comments

@nschloe
Copy link
Contributor

nschloe commented May 20, 2014

There are two options (maybe more) that handle the generation of documentation, namely BUILD_DOCS and ENABLE_DOXYGEN.

Which parts of the documentation are build if those are set to ON and OFF, respectively? The option BUILD_DOCS should then probably be renamed to something more descriptive, or the option ENABLE_DOXYGEN should be removed and at the same time doxygen be made a requirement if BUILD_DOCS is true.

@WardF
Copy link
Member

WardF commented May 21, 2014

Build docs is set equal to the value of enable_doxygen, assuming doxygen is found. There's no good reason to have it this way (although it doesn't really hurt anything); when building the initial CMakeList.txt files, I patterned them after the autotools-based configuration files, which uses the same convention.

I'm looking to make sure that there are no unexpected side effects from removing BUILD_DOCS; assuming there aren't, I'll close this issue out after removing it.

@WardF
Copy link
Member

WardF commented May 21, 2014

Removed BUILD_DOCS in commit 48a3aa5, which will be pushed out shortly.

@WardF WardF closed this as completed May 21, 2014
@DennisHeimbigner
Copy link
Collaborator

Should this be removed from the automake as well?
=dennis

Ward Fisher wrote:

Removed BUILD_DOCS in commit 48a3aa5, which will be pushed out shortly.


Reply to this email directly or view it on GitHub:
#59 (comment)

@WardF
Copy link
Member

WardF commented May 21, 2014

It appears to be an internal variable used in automake, and is not exposed
as a configuration flag the way it was in CMake. Even if it's superfluous
(which I'm not entirely sure if it is or not), it maintains the convention
used with most other flags used in the autotools system. So, for the time
being I'll leave it in until I can take a better look at it. :)

On Wed, May 21, 2014 at 2:18 PM, DennisHeimbigner
notifications@github.comwrote:

Should this be removed from the automake as well?
=dennis

Ward Fisher wrote:

Removed BUILD_DOCS in commit 48a3aa5,
which will be pushed out shortly.


Reply to this email directly or view it on GitHub:
#59 (comment)


Reply to this email directly or view it on GitHubhttps://github.com//issues/59#issuecomment-43808444
.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants