Skip to content
This repository has been archived by the owner on Apr 15, 2019. It is now read-only.

Document source code using YUIDoc #30

Closed
karmacoma opened this issue Feb 3, 2017 · 2 comments
Closed

Document source code using YUIDoc #30

karmacoma opened this issue Feb 3, 2017 · 2 comments

Comments

@karmacoma
Copy link
Contributor

We should document the lisk-nano source code using: http://yui.github.io/yuidoc/

New code can be documented immediately: http://yui.github.io/yuidoc/syntax/index.html

Existing code we cover here, module by module.

@karmacoma karmacoma added the docs label Feb 3, 2017
@slaweet slaweet self-assigned this Mar 6, 2017
@reyraa reyraa self-assigned this Apr 18, 2017
@karmacoma karmacoma modified the milestone: Version 1.0.0 Apr 26, 2017
@reyraa
Copy link
Contributor

reyraa commented May 4, 2017

@karmacoma Please clarify:

  • Should all the public method of the services get documented?
  • Should we define types for parameters?
    • If yes, Should we check for parameter types in logic?
  • Should we add parameter description
  • Should we define return types?
    • If yes, Should we restrict functions to a single return type?
  • Should we use descriptions?

@reyraa reyraa self-assigned this May 5, 2017
@reyraa
Copy link
Contributor

reyraa commented May 9, 2017

As @karmacoma suggested we're going to start with:

  • Only for public methods.
  • Define types for parameters.
  • No descriptions yet.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants