Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some improvements to the documentation #47

Merged
merged 2 commits into from Jun 25, 2019

Conversation

@aperezdc
Copy link
Contributor

commented Jun 17, 2019

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/

docs/loader.md Outdated Show resolved Hide resolved
aperezdc added 2 commits Jun 17, 2019
CMake: Fix path of include directories for HotDoc
This makes it possible for HotDoc to find the generated version.h
header.
doc: Reorganize HotDoc sources, start documenting
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 aperezdc force-pushed the aperezdc/hotdoc-love branch from c3ac839 to 18a81f7 Jun 24, 2019

@aperezdc aperezdc requested a review from thiblahute Jun 25, 2019

@thiblahute
Copy link
Contributor

left a comment

Looks good to me.

include/wpe/version.h.cmake Show resolved Hide resolved

@aperezdc aperezdc merged commit 7f1bfe3 into master Jun 25, 2019

@aperezdc

This comment has been minimized.

Copy link
Contributor Author

commented Jun 25, 2019

Merged, given that our resident HotDoc expert agreed with the changes 😉

@thiblahute

This comment has been minimized.

Copy link
Contributor

commented Jun 25, 2019

Do you have the macros documented now?

@aperezdc

This comment has been minimized.

Copy link
Contributor Author

commented Jun 25, 2019

@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
2 participants
You can’t perform that action at this time.