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.

Sign up for GitHub

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

Jump to bottom

Add documentation for the public API #27

Open
aperezdc opened this issue Nov 22, 2018 · 5 comments
Open

Add documentation for the public API #27

aperezdc opened this issue Nov 22, 2018 · 5 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@aperezdc
Copy link
Member

Probably we would want to use GTK-Doc, which despite the name does not need GTK+ at all. That would allow cross-linking to the WPE WebKit API reference if needed.

See also WebPlatformForEmbedded/libwpe#37 and BWO#178900.
@aperezdc aperezdc added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Nov 22, 2018
@philn
Copy link
Member

philn commented Nov 22, 2018

Or Hotdoc?

@aperezdc
Copy link
Member Author

@philn Is that this HotDoc? I didn't know about it, looks like a good option as well!

@philn
Copy link
Member

philn commented Nov 22, 2018

Yes! GStreamer is migrating to it as well.

@In-vincible
Copy link

@aperezdc is this issue up for grabs from beginners? If yes, please provide me with some more help about how to start with the work.

@aperezdc
Copy link
Member Author

aperezdc commented Feb 8, 2019

@In-vincible Some help documenting the public API would definitely be appreciated. The tricky bit is to have the support for building the documentation; I have just posted #29 to wire HotDoc into the build system, once that patch merged, you should be able to do:

cmake -DBUILD_DOCS=ON
make Documentation
xdg-open Documentation/html/c-index.html

Once that is working, you can start adding documentation next to function declarations using the GTK-Doc syntax (HotDoc uses the same syntax for C code), and re-run make Documentation to regenerate the HTML pages with your changes.

Please do ask if you need some more help from that point on, and remember that you can find us in the #webkit channel in the Freenode IRC 👋

@aperezdc aperezdc mentioned this issue Jun 10, 2019
Closed
JPEWdev pushed a commit to JPEWdev/WPEBackend-fdo that referenced this issue Jul 24, 2019
@aperezdc
Rename the libWPEBackend library just to libwpe
0066d95 
This library does not actually implement any backend for WPE, and
therefore its name can be misleading. Instead, it contains the code
needed by WebKit to interface with actual backend implementations,
loading them, and some utility code. The libwpe name is much more
fitting.

This is a good moment to do this rename, because the API version will
be bumped for release 1.0.0 as well: packagers and users of the library
will need to update anyway for the API version change and rebuild
software which uses libWPEBackend^W libwpe anyway.

Fixes Igalia#27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@philn @aperezdc @In-vincible