As a Lucy extension writer for Go, I would love to see docs for the C API. Currently I've got to grope around the header files for both clownfish and Lucy in order to figure out functionality, which is not as fun as it sounds.
Philip Southam Chief Architect / Яeverse Эngineer http://zefr.com On Aug 26, 2014 3:16 AM, "Nick Wellnhofer" <[email protected]> wrote: > Lucifers, > > I'd like to add the Clownfish C API documentation to our generated Perl > PODs, so developers of Perl extensions can find all the docs in one place. > I'm thinking of creating POD files like Clownfish/Docs/C/VArray.pod for > every Clownfish class. There are some classes like LockFreeRegistry that > shouldn't be exposed, maybe by marking them private. But we can deal with > that later. > > For Lucy extension writers, it would also be useful to have the C API > documented in POD format. But I don't want to clutter the documentation > with another 150 files. Maybe we could organize the Lucy C API docs by > subdirectory, like Lucy/Docs/C/Search.pod. > > Nick >
