NeotomaDB / Neotoma-API

A Placeholder for the Neotoma API
3 stars 1 forks source link

Neotoma API documentation needs to be updated. #4

Open SimonGoring opened 8 years ago

SimonGoring commented 8 years ago

New resources & options aren't in the API documentation. @spatialit is the documentation auto-generated, or does it need to be manually updated?

spatialit commented 8 years ago

It needs to be manually updated. I'll see if Brian told Mike S. where it is.

SimonGoring commented 8 years ago

Is it auto-generated from the API code though? The EC provisional guidelines talk about using something like Doxygenize to generate documentation. Not sure if that's a possibility, but I just wanted to get a sense of how the documentation is actually generated.

spatialit commented 8 years ago

It isn't connected in any way to the API code right now. Brian used something called docuwiki to generate it. We could use something to generate it from the code. The MuleSoft tools we were looking at to design the composite API handles this. The documentation doesn't look quite as nice, but it is much easier to update.