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.

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

[doc] To Embed Document in Wechaty Code for Generating Automaticly #73

Closed
zixia opened this Issue Nov 4, 2016 · 4 comments

Comments

@zixia
Member

zixia commented Nov 4, 2016

The Public API of Wechaty is almost not changed much during the past five months, but the module is increasing, and the internal API is changed a lot.

We need to document them better, not only the public but also the internal modules and methods.

So a document generator with embed document in code needs to be considering from now.

I'd like to prefer Dgeni, which is the Documentation Generator of AngularJS/Angular Material/Protractor/Ionic.

Here're some useful links:


Update on Feb 2017:

Finally we decided to use the classic jsdoc to embed document in TypeScript, then generate document to docs/ by jsdoc2md.

@zixia zixia added this to the v0.6 milestone Nov 4, 2016

@zixia zixia added the enhancement label Nov 4, 2016

@sleedata

This comment has been minimized.

Show comment
Hide comment
@sleedata

sleedata Nov 4, 2016

@zixia, I'll look into this.

sleedata commented Nov 4, 2016

@zixia, I'll look into this.

@kis87988

This comment has been minimized.

Show comment
Hide comment
@kis87988

kis87988 Jun 26, 2017

Contributor

I will try to contribute about this issue

Contributor

kis87988 commented Jun 26, 2017

I will try to contribute about this issue

@zixia

This comment has been minimized.

Show comment
Hide comment
@zixia

zixia Jun 26, 2017

Member

@kis87988 Hope you could help the community to get a better version of Documentations!

Member

zixia commented Jun 26, 2017

@kis87988 Hope you could help the community to get a better version of Documentations!

@zixia

This comment has been minimized.

Show comment
Hide comment
@zixia

zixia Aug 26, 2017

Member

Close this issue because the PR will be merged soon.

Member

zixia commented Aug 26, 2017

Close this issue because the PR will be merged soon.

@zixia zixia closed this Aug 26, 2017

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