search

reTHINK-project / core-framework

The main goal of WP3 is to provide the reTHINK core framework comprised by the runtime environment where Hyperties are executed and the messaging nodes used to support messages exchange between Hyperties.
Apache License 2.0
1 stars 0 forks source link

Service Framework API docs #156

Closed pchainho closed 7 years ago

pchainho commented 8 years ago

Use same tools as in #155

To go for annex

acheambe commented 8 years ago

Link to API generated Docs using ESDoc can be found here.

pchainho commented 8 years ago

In the core runtime the JSDOC is used. We should use the same. Which one?

We should also have the same location:

docs/api

acheambe commented 8 years ago

Sources of MessageFactory, Syncher, Cataloguefactory, HypertyDiscovery documented and esdoc generated. Can be found here

acheambe commented 8 years ago

some classes still need to be fully documented, but the most important once at this stage are documented.

shumy commented 8 years ago

There are a lot of "Static Public Variables" that seems to be useless in the documentation, originated from imports. Is there any way to remove these?