Skip to content

Generated documentation from code #94

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

Open
4 of 10 tasks
bertfrees opened this issue Feb 1, 2017 · 3 comments
Open
4 of 10 tasks

Generated documentation from code #94

bertfrees opened this issue Feb 1, 2017 · 3 comments

Comments

@bertfrees
Copy link
Member

bertfrees commented Feb 1, 2017

API documentation

  • [doing] javadoc M
  • [doing] xprocdoc M
  • xsl-doc M
  • CSS
  • liblouis tables

generated script documentation

htmlized sources

i.e. grepcode-like documentation of source code

  • done for XProc, XSLT, CSS, catalog.xml
  • to do: for Java (possibly with maven-jxr-plugin)
  • to do: braille CSS support for Coderay
@bertfrees
Copy link
Member Author

@josteinaj I have added the clientlib-java javadocs to the website: http://daisy.github.io/pipeline/Contribute.

Is this how it is supposed to look? Is there some specific entrypoint we should point to? org.daisy.pipeline.client.http.WS maybe? Are there some packages/classes we should hide from the user? (If we have a single entry point, all classes that can not be reached from that entrypoint should ideally be hidden.)

Note that I haven't linked up the two modules (clientlib-java and clientlib-java-httpclient) yet so you can't go e.g. from WS to Job.

@josteinaj
Copy link
Member

Looks good! WS could be emphasized, yes. I can't think of anything in specific that needs to be hidden.

Linking up the two JavaDocs would be useful.

@bertfrees
Copy link
Member Author

Done.

@bertfrees bertfrees added this to the Next milestone Oct 19, 2017
@bertfrees bertfrees self-assigned this Oct 19, 2017
@bertfrees bertfrees removed this from the Next milestone Apr 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants