Skip to content
This repository has been archived by the owner on Mar 28, 2023. It is now read-only.

documentation: provide updated API doc #132

Closed
x1B opened this issue Nov 24, 2014 · 3 comments
Closed

documentation: provide updated API doc #132

x1B opened this issue Nov 24, 2014 · 3 comments
Assignees
@alex3683
Labels
epic: developer tools type: enhancement
Milestone
v1.0.0

Comments

@x1B
Copy link
Member

x1B commented Nov 24, 2014

Depends on #128.

Document these APIs, and make generating/browsing API documentation simple:

  • maybe use dgeni?
  • replace/update laxar_docs
@x1B x1B mentioned this issue Feb 12, 2015
Closed
@x1B x1B added this to the v1.0.0 milestone Mar 24, 2015
@x1B x1B removed the blocks-1.0 label Mar 24, 2015
@alex3683 alex3683 self-assigned this Apr 30, 2015
@alex3683
Copy link
Member

For api generation Laxar Dox was revived and refactored, and a basic Grunt Laxar task was created. Hence we can use that to generate API doc.

Open tasks:

  • Improve api doc where necessary and add missing keywords (i.e. @injection)
  • Generate the api doc into the Laxar and Laxar dist package

@alex3683
Copy link
Member

First changes on branch feature/132-updating-documentation.

alex3683 pushed a commit that referenced this issue May 28, 2015
(#132) documentation: provided updated API doc for relevant modules
5ac373d
@alex3683
Copy link
Member

Implemented on master (v1.0.0).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@alex3683 alex3683

Labels
epic: developer tools type: enhancement
Projects
None yet
Milestone
v1.0.0
Development

No branches or pull requests
2 participants
@x1B @alex3683