BUILD_DOCS, ENABLE_DOXYGEN

[nschloe]

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]

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]

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

[DennisHeimbigner]

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]

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
.