Some improvements to the documentation #47
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thiblahute
reviewed
Jun 17, 2019
This makes it possible for HotDoc to find the generated version.h header.
Manually group the deprecated versioning symbols in a general version section, and start documenting some of the headers. Additionally, make HotDoc pick the generated headers, and do some small tweaks to its invocation.
aperezdc
force-pushed
the
aperezdc/hotdoc-love
branch
from
c3ac839 to
18a81f7
Compare
|
Merged, given that our resident HotDoc expert agreed with the changes 😉 |
|
Do you have the macros documented now? |
|
@thiblahute Not yet, I'll make a new PR with a few more things documented in the next days. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change a bit how HotDoc is invoked, and start documenting the public API. Note that this is a shy start, and it would be great to have more people contribute with documentation—but at least this is a start!
See #37
You can see how the generated documentation looks at https://people.igalia.com/aperez/libwpe-doc-sample/