Add doxygen build target

Add doxygen build target.

BUG=none
R=jvoung@chromium.org, stichnot@chromium.org

Committed: https://gerrit.chromium.org/gerrit/gitweb?p=native_client/pnacl-subzero.git;a=commit;h=a509e1d8ca5375b86572d6942f416ac5952cdd3e

[ascull, 2015-06-24 19:18:34]

ascull@google.com changed reviewers:
+ jpp@chromium.org, jvoung@chromium.org, stichnot@chromium.org

[Jim Stichnoth, 2015-06-24 20:36:56]

https://codereview.chromium.org/1207823002/diff/1/Doxyfile
File Doxyfile (right):

https://codereview.chromium.org/1207823002/diff/1/Doxyfile#newcode1390
Doxyfile:1390: # Use the FORMULA_TRANPARENT tag to determine whether or not the
images
FORMULA_TRANSPARENT

https://codereview.chromium.org/1207823002/diff/1/Doxyfile#newcode1950
Doxyfile:1950: # remove all refrences to function-like macros that are alone on
a line, have an
references

https://codereview.chromium.org/1207823002/diff/1/Makefile.standalone
File Makefile.standalone (right):

https://codereview.chromium.org/1207823002/diff/1/Makefile.standalone#newcode341
Makefile.standalone:341: docs: make_symlink Doxyfile
Can probably omit the make_symlink dependency, since (I assume) doxygen doesn't
require pnacl-sz to be built.

Also, it would be nice if it could be made to rerun doxygen only if some file in
$(SRCS) or src/*.h or src/*.def changes.

https://codereview.chromium.org/1207823002/diff/1/Makefile.standalone#newcode342
Makefile.standalone:342: doxygen Doxyfile
Would be nice to @echo the html file to load in the browser, similar to the
bloat target above.

https://codereview.chromium.org/1207823002/diff/1/Makefile.standalone#newcode348
Makefile.standalone:348: rm -rf build/
Remove docs/ here as well?

[jvoung (off chromium), 2015-06-24 20:45:18]

https://codereview.chromium.org/1207823002/diff/1/Doxyfile
File Doxyfile (right):

https://codereview.chromium.org/1207823002/diff/1/Doxyfile#newcode895
Doxyfile:895: SOURCE_BROWSER         = NO
YES might be useful? At least LLVM does that, but I don't know what it actually
does.

https://codereview.chromium.org/1207823002/diff/1/Doxyfile#newcode914
Doxyfile:914: REFERENCED_BY_RELATION = NO
LLVM sets this to "YES" fwiw

https://codereview.chromium.org/1207823002/diff/1/Doxyfile#newcode920
Doxyfile:920: REFERENCES_RELATION    = NO
similar (llvm uses yes)

https://codereview.chromium.org/1207823002/diff/1/Doxyfile#newcode994
Doxyfile:994: IGNORE_PREFIX          =
llvm does "llvm::" Perhaps we should do "Ice::" ?

https://codereview.chromium.org/1207823002/diff/1/Doxyfile#newcode1543
Doxyfile:1543: GENERATE_LATEX         = YES
I miss LaTeX a bit, but fwiw, LLVM sets this to NO.

It seems to be much faster without LaTeX output (make -f Makefile.standalone
docs  2.67s user 0.37s system 64% cpu 4.675 total), so it might be a good
tradeoff if people aren't using the latex files.

[Jim Stichnoth, 2015-06-26 00:56:19]

lgtm

https://codereview.chromium.org/1207823002/diff/60001/Makefile.standalone
File Makefile.standalone (right):

https://codereview.chromium.org/1207823002/diff/60001/Makefile.standalone#new...
Makefile.standalone:341: docs:
Seems like this should still depend on the Doxyfile?  (not a big deal either
way)

[jvoung (off chromium), 2015-06-26 01:24:18]

LGTM remember to click the comments that are addressed and hit the "Done"
buttons that pop up =)

https://codereview.chromium.org/1207823002/diff/1/Doxyfile
File Doxyfile (right):

https://codereview.chromium.org/1207823002/diff/1/Doxyfile#newcode895
Doxyfile:895: SOURCE_BROWSER         = NO
On 2015/06/24 20:45:18, jvoung wrote:
> YES might be useful? At least LLVM does that, but I don't know what it
actually
> does.

Done.

[ascull, 2015-06-29 17:05:11]

https://codereview.chromium.org/1207823002/diff/1/Doxyfile
File Doxyfile (right):

https://codereview.chromium.org/1207823002/diff/1/Doxyfile#newcode914
Doxyfile:914: REFERENCED_BY_RELATION = NO
On 2015/06/24 20:45:17, jvoung wrote:
> LLVM sets this to "YES" fwiw

Done.

https://codereview.chromium.org/1207823002/diff/1/Doxyfile#newcode920
Doxyfile:920: REFERENCES_RELATION    = NO
On 2015/06/24 20:45:17, jvoung wrote:
> similar (llvm uses yes)

Done.

https://codereview.chromium.org/1207823002/diff/1/Doxyfile#newcode994
Doxyfile:994: IGNORE_PREFIX          =
On 2015/06/24 20:45:18, jvoung wrote:
> llvm does "llvm::" Perhaps we should do "Ice::" ?

Done.

https://codereview.chromium.org/1207823002/diff/1/Doxyfile#newcode1390
Doxyfile:1390: # Use the FORMULA_TRANPARENT tag to determine whether or not the
images
On 2015/06/24 20:36:55, stichnot wrote:
> FORMULA_TRANSPARENT

Done.

https://codereview.chromium.org/1207823002/diff/1/Doxyfile#newcode1543
Doxyfile:1543: GENERATE_LATEX         = YES
On 2015/06/24 20:45:18, jvoung wrote:
> I miss LaTeX a bit, but fwiw, LLVM sets this to NO.
> 
> It seems to be much faster without LaTeX output (make -f Makefile.standalone
> docs  2.67s user 0.37s system 64% cpu 4.675 total), so it might be a good
> tradeoff if people aren't using the latex files.

Done.

https://codereview.chromium.org/1207823002/diff/1/Doxyfile#newcode1950
Doxyfile:1950: # remove all refrences to function-like macros that are alone on
a line, have an
On 2015/06/24 20:36:55, stichnot wrote:
> references

Done.

https://codereview.chromium.org/1207823002/diff/60001/Makefile.standalone
File Makefile.standalone (right):

https://codereview.chromium.org/1207823002/diff/60001/Makefile.standalone#new...
Makefile.standalone:341: docs:
On 2015/06/26 00:56:18, stichnot wrote:
> Seems like this should still depend on the Doxyfile?  (not a big deal either
> way)

As it is a PHONY target it is always out of date so dependencies don't make a
difference. It would be better to have proper dependencies but I couldn't get
that to work properly for doxygen.

[ascull, 2015-06-29 18:07:12]

Committed patchset #4 (id:60001) manually as
a509e1d8ca5375b86572d6942f416ac5952cdd3e (presubmit successful).