Where do we document functions in API?

Open ajfriend opened this issue 5 years ago • 2 comments

Should we come up with a standard place for documenting the user-facing functions in the API?

It seems like we currently have documentation in both h3api.h and in the .c files. If these disagree, for example, which should a user believe? Should we agree on a single place for this documentation, maybe just the h3api.h header?

Jan 19 '20 02:01 ajfriend

Neither of these are what builds the documentation website, which pulls from a different description of the functions in the docs directory. If we make a single place for documentation I'd want it to feed into that as well.

Jan 19 '20 04:01 isaacbrodsky

I wonder if we could automate that? Does the project still use doxygen? I see it referenced in the source code, but I can't tell if we're actually using it to build documentation?

I wonder if we could set things up so that the documentation website builds from doxygen comments in h3api.h?

Jan 20 '20 21:01 ajfriend