bitshares / bitshares/bitshares-core

apidocs

Open
#792 18 comments 1 reaction 0 assignees View on GitHub
1b User Story 2d Developing 3c Enhancement 5a Docs Needed 6 API code cleanup documentation
Dominant language
C++
Stars
1.2k
Forks
660
Avg merge
8h 17m
Merged PRs (30d)
26

Description

http://apidocjs.com/

MIT licensed documentation page generator similar to doxygen but with focus on documenting the api calls.
It is currently being implemented by eos between other exchanges with api access. it will provide new developers a familiar and clean api website.

there are other options around like: https://github.com/lord/slate

apidocs is easy to use (example generated very quick: http://open-explorer.io/apidoc/) but we need to add specially formatted comments of the calls into the cpp files.
as our `database_api.cpp` and `api.cpp` are already big i also propose to refactor and split in different files by groups just as `account_api.cpp`, `objects_api.cpp` and so on.
this will make some progress in: https://github.com/bitshares/bitshares-core/issues/95

i didn't checked how hard it will be to separate the apis into files without breaking anything or what will be the best approach.

suggestions welcome.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.