Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

jsdoc documentation #28

Closed
lpatiny opened this issue Nov 18, 2016 · 3 comments
Closed

jsdoc documentation #28

lpatiny opened this issue Nov 18, 2016 · 3 comments
Assignees
@andcastillo

Comments

@lpatiny
Copy link
Member

lpatiny commented Nov 18, 2016

Currently there is some documentation in the code but it is not written in the correct format.

You may get inspired by : https://github.com/image-js/core/blob/master/src/image/transform/grey.js

However in this case

  • @memberof Image
  • @instance
    is probably not required because documentation-js can figure out by itself it is a method of the associated class.
@stropitek
Copy link
Contributor

stropitek commented Dec 6, 2016 •
edited
Loading

See also #52

jobo322 added a commit that referenced this issue Jan 16, 2017
@jobo322
advances in the documentation
f7cbc19 
with respect to issues #19 #28 #48 #52
@andcastillo
Copy link
Contributor

Can we close this? The documentation is correct now?

@andcastillo
Copy link
Contributor

@stropitek @lpatiny ?

@lpatiny lpatiny closed this as completed Feb 21, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@andcastillo andcastillo

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@lpatiny @andcastillo @stropitek