Gumbo-parser: API Documentation is missing or its location is not documented
The README.md5 file says "See the API documentation and sample programs for more details." (no link provided) however I cannot find this referenced API documentation anywhere. The sample programs in the "examples" directory do not contain said documentation. The README gives a limited example of how to actual perform the parse, but tells me nothing about what the "GumboOutput" structure is or what can be done with it. I have looked in all the sub-directories but see nothing documenting the API.
I found a separate page via Google (http://matze.github.io/clib-doc/gumbo-parser/index.html) but I don't know how it relates to this version, and it is very incomplete (for instance, I still don't see anything about the "GumboOutput" struct or what can be done with it.)
michael-ts
All 3 comments
I would like to browse the API documentation, but don't particularly want to clone the repo and install doxygen yet. Can you consider hosting the built docs somewhere?
kiwidrew
on 4 Apr 2017
Can we not setup Github Pages with possible code / API usage?
duraki
on 15 Jan 2018
FWIW, the complete user API is documented in gumbo.h. If you are looking for examples for using the api, the serializer touches on most of the user side functionality of the library. When accessed via python, the api is extended since the C based parsed tree is converted to its bs4 equivalent after the parse completes.
kevinhendricks
on 16 Jan 2018
Related issues
eduardokranz
·
6Comments
greg0ire
·
38Comments
iamnader
·
125Comments
gullbyrd
·
14Comments
MB34
·
22Comments
Most helpful comment
FWIW, the complete user API is documented in gumbo.h. If you are looking for examples for using the api, the serializer touches on most of the user side functionality of the library. When accessed via python, the api is extended since the C based parsed tree is converted to its bs4 equivalent after the parse completes.