On Tue, Jun 23, 2009 at 11:41 AM, Jeremy Orlow<[email protected]> wrote: > For what it's worth, I was really impressed by the O3D documentation: > http://code.google.com/apis/o3d/docs/index.html > Not sure how they did it, but I believe it was all generated. Not sure if > that's close enough to what you had envisioned.
About O3D: for API docs, we put it in our IDL files that describe the bindings to JavaScript (it's a custom IDL language, somewhat close to WebIDL, but not quite the same). From there, the way it works today is that we generate C++ headers, that we feed to Doxygen, we parse the output to make it more JS-y and less C++-y, and then some extra magic steps happen to make it look pretty. In some future though, we'll directly generate a JS "header" and use jsdoc-toolkit. The good thing is that the doc doesn't clutter C++ files which are the meat of the plugin, but lives in the IDL which describe the API itself, and though that's somewhat specific to our case, it works very nicely: if you're working on the interface, the doc is right there to edit, if you're just changing the implementation you don't have to worry about it. Antoine > > On Tue, Jun 23, 2009 at 11:36 AM, Aaron Boodman <[email protected]> wrote: >> >> We're getting to the point with the extensions project where we need >> to figure out how our documentation will work. From working on Gears, >> Greasmonkey, and other previous projects I have some strong feelings >> about how it should *not* work, and that led naturally to: >> >> >> http://sites.google.com/a/chromium.org/dev/developers/design-documents/extensions/doc-viewer-design-doc >> >> Feedback desired. >> >> Before people ask: No, I have not yet seriously investigated any >> existing systems (Doxygen, Bigbook) that we could reuse, rather than >> build. It could very well be that something like this -- or close >> enough -- already exists. Part of next steps would be to investigate >> reusing existing options. >> >> - a >> >> > > > > > -- A: Because it messes up the order in which people normally read text. Q: Why is top-posting such a bad thing? A: Top-posting. Q: What is the most annoying thing in e-mail? --~--~---------~--~----~------------~-------~--~----~ Chromium Developers mailing list: [email protected] View archives, change email options, or unsubscribe: http://groups.google.com/group/chromium-dev -~----------~----~----~----~------~----~------~--~---
