ci: Build and store doxygen documentation #692
Conversation
Codecov Report
@@ Coverage Diff @@
## master #692 +/- ##
=======================================
Coverage 99.30% 99.30%
=======================================
Files 72 72
Lines 10300 10300
=======================================
Hits 10228 10228
Misses 72 72
Flags with carried forward coverage won't be shown. Click here to find out more. |
| // Fizzy: A fast WebAssembly interpreter | ||
| // Copyright 2020 The Fizzy Authors. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| /// @file |
There was a problem hiding this comment.
Without this file is considered private by default and documentation for free functions is not generated.
There was a problem hiding this comment.
Are you sure it can't just be added in the doxygen config?
There was a problem hiding this comment.
Well adding the file explicitly in INPUT doesn't help (it's included anyway)
The only other way to fix it that I found is to set EXTRACT_ALL = YES, but it might include more stuff than needed, EVMC has it at NO.
There was a problem hiding this comment.
https://www.doxygen.nl/manual/commands.html#cmdfile
The documentation of global functions, variables, typedefs, and enums will only be included in the output if the file they are in is documented as well or if EXTRACT_ALL is set to YES.
There was a problem hiding this comment.
This is done wrongly. We don't want to the "copyright header" to be included in the documentation text.
It rather should be
// Copyright...
/// Fizzy public C API.
/// @file
There was a problem hiding this comment.
Changed. I just hate doxygen 😠
There was a problem hiding this comment.
clang-doc maybe if you want to contribute to LLVM.
| # Note: If this tag is empty the current directory is searched. | ||
|
|
||
| INPUT = include/fizzy/ \ | ||
| lib/fizzy/ \ |
There was a problem hiding this comment.
Do we want to include these internal files?
There was a problem hiding this comment.
Do we want to use this doxygen generated file for the external documentation only or as a project documentation?
There was a problem hiding this comment.
Perhaps we can decide later, and for now merge it like this, to have something working.
There was a problem hiding this comment.
I'd go with generating docs for everything as a start. There may be better way of separating public and internal API.
There was a problem hiding this comment.
E.g. there is @internal tag. https://stackoverflow.com/questions/11025971/separate-internal-from-external-documentation-in-doxygen
| // Fizzy: A fast WebAssembly interpreter | ||
| // Copyright 2020 The Fizzy Authors. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| /// @file |
There was a problem hiding this comment.
clang-doc maybe if you want to contribute to LLVM.
Doxyfile
Outdated
| # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy | ||
| # the logo to the output directory. | ||
|
|
||
| PROJECT_LOGO = |
There was a problem hiding this comment.
I tried locally, and it didn't work for me.
There was a problem hiding this comment.
Actually, it does work, when I resize it to 200x200.
Doxyfile
Outdated
| # types are typedef'ed and only the typedef is referenced, never the tag name. | ||
| # The default value is: NO. | ||
|
|
||
| TYPEDEF_HIDES_STRUCT = NO |
There was a problem hiding this comment.
Can y'all check the description above if it applies to us? I don't think we do too much typedefing.
There was a problem hiding this comment.
This should be YES.
|
I split Doxyfile into two commits:
|
chfast
force-pushed
the
ci_doxygen
branch
2 times, most recently
from
cc283c9
to
eae8072
Compare
Part of #531.