API Reference Outdated + Broken

[Rodrigo Silveira]

The new Google Developers page that describes the library links to this API reference page: http://docs.closure-library.googlecode.com/git/index.html

That page looks older than the current version of the source code (it references code hosted on Google Code), and all the examples link off to 404s. On top of that, that design is not necessarily helpful on a mobile device (where I've been looking it up most of the time).

Questions:

1. Is there a better version of the API reference that I don't know of?
   
2. How could I go about generating some docs out of the source code? I've been trying jsdoc, but can't figure it out.

Thanks.

[Erik Neumann]

Hi Rodrigo,

I don't know of any actively maintained API docs for closure library.  Those pages are indeed older and probably somewhat out of date.  For myself I usually just read the docs in the code itself.

My understanding is those docs were generated using an internal Google tool.

The public JSDoc project at http://usejsdoc.org is a kind of distant cousin to the Google Closure project and until recently they have not worked well together.  Some recent changes to JSDoc have made it possible for me to use JSDoc on my Google Closure based project, so the situation is improving.  Specifically, the new JSDoc 3.3.0 version has better support for the @interface tags and inheritance among interfaces and classes that implement interfaces.

Another valuable reference is the book "Closure The Definitive Guide" by Michael Bolin.

Regards,

--ErikN

--

---
You received this message because you are subscribed to the Google Groups "Closure Library Discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to closure-library-d...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Andy Martone]

Yeah sorry, those docs are old and crufty. Nathan is working on a new system to generate docs, stay tuned.

[Peter StJ]

Any chance that it could be open sources/could be used for external projects?

It would be nice to provide nice docs view for the customers of our library code and current jsdoc does not do it so well...

On Friday, 3 April 2015 20:03:54 UTC+3, Andy Martone wrote:

Yeah sorry, those docs are old and crufty. Nathan is working on a new system to generate docs, stay tuned.

On Thu, Apr 2, 2015 at 8:04 PM, Erik Neumann <er...@myphysicslab.com> wrote:

Hi Rodrigo,

I don't know of any actively maintained API docs for closure library.  Those pages are indeed older and probably somewhat out of date.  For myself I usually just read the docs in the code itself.

My understanding is those docs were generated using an internal Google tool.

The public JSDoc project at http://usejsdoc.org is a kind of distant cousin to the Google Closure project and until recently they have not worked well together.  Some recent changes to JSDoc have made it possible for me to use JSDoc on my Google Closure based project, so the situation is improving.  Specifically, the new JSDoc 3.3.0 version has better support for the @interface tags and inheritance among interfaces and classes that implement interfaces.

Another valuable reference is the book "Closure The Definitive Guide" by Michael Bolin.

Regards,

--ErikN

On Thu, Apr 2, 2015 at 6:52 PM, Rodrigo Silveira <rodr...@gmail.com> wrote:

The new Google Developers page that describes the library links to this API reference page: http://docs.closure-library.googlecode.com/git/index.html

That page looks older than the current version of the source code (it references code hosted on Google Code), and all the examples link off to 404s. On top of that, that design is not necessarily helpful on a mobile device (where I've been looking it up most of the time).

Questions:

1. Is there a better version of the API reference that I don't know of?
   
2. How could I go about generating some docs out of the source code? I've been trying jsdoc, but can't figure it out.

Thanks.

--

---
You received this message because you are subscribed to the Google Groups "Closure Library Discuss" group.

To unsubscribe from this group and stop receiving emails from it, send an email to closure-library-discuss+unsub...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--

---
You received this message because you are subscribed to the Google Groups "Closure Library Discuss" group.

To unsubscribe from this group and stop receiving emails from it, send an email to closure-library-discuss+unsub...@googlegroups.com.

[Andy Martone]

Nathan pushed out a new version of our docs: http://google.github.io/closure-library/api/index.html

It's using js-dossier to generate them: https://github.com/jleyba/js-dossier

To unsubscribe from this group and stop receiving emails from it, send an email to closure-library-d...@googlegroups.com.

[Nathan Naze]

This is very beta. I will do a fuller announcement when some simple
polish has been added.

Nathan