Skip to content

MINIFI-265: Add conditional statement for doc generatin#78

Closed
phrocker wants to merge 2 commits intoapache:masterfrom
phrocker:MINIFI-265
Closed

MINIFI-265: Add conditional statement for doc generatin#78
phrocker wants to merge 2 commits intoapache:masterfrom
phrocker:MINIFI-265

Conversation

@phrocker
Copy link
Contributor

If Doxygen is installed you can run make docs to generate
HTML and LaTeX output.

Thank you for submitting a contribution to Apache NiFi - MiNiFi C++.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced
    in the commit message?

  • Does your PR title start with MINIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

  • Has your PR been rebased against the latest commit within the target branch (typically master)?

  • Is your initial contribution a single, squashed commit?

For code changes:

  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • If applicable, have you updated the LICENSE file?
  • If applicable, have you updated the NOTICE file?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.

If Doxygen is installed you can run make docs to generate
HTML and LaTeX output.
Copy link
Member

@apiri apiri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to apply license to the Doxyfile, but otherwise looks good. Target works as anticipated and generated documents looked good.

@@ -0,0 +1,2474 @@
# Doxyfile 1.8.13
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will need Apache License on this file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool Updated. Thanks!

@apiri
Copy link
Member

apiri commented Apr 11, 2017

Looks good. Thanks! Will merge.

@asfgit asfgit closed this in 11c6c40 Apr 11, 2017
nghiaxlee pushed a commit to nghiaxlee/nifi-minifi-cpp that referenced this pull request Jul 8, 2019
If Doxygen is installed you can run make docs to generate
HTML and LaTeX output.

This closes apache#78.

Signed-off-by: Aldrin Piri <aldrin@apache.org>
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

Successfully merging this pull request may close these issues.

2 participants