Writing documentation - open source solutions for displaying docs online? [closed]

Closed. This question is seeking recommendations for books, tools, software libraries, and more. It does not meet Stack Overflow guidelines guidelines. It is not currently accepting answers.

---

We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.

Closed 5 years ago.

Improve this question

I've been working on a framework in AS3 that I want to release, but first I obviously need to prepare some documentation for it.

I've noticed that quite a few sites have the exact same layout, functionality etc as Adobe Livedocs, which has let me to believe that there's something open source out there for creating online documentation.

Here's some examples:

1. http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/
2. http://papervision3d.googlecode.com/svn/trunk/as3/trunk/docs/index.html
3. http://www.fisixengine.com/api/

Would anyone be able to point me in the right direction for tools that I can use to prepare online documentation?

Ideally the system开发者_开发问答 would be specifically suited for documentation in ActionScript 3. I don't have a requirement in terms of the documentation being automatically generated either - if there's something out there that looks/works nice I'm happy to manually create the documentation (provided it comes with tools for easily adding classes, arguments, etc).

---

Adobe has a free tool called ASDoc. It generates documentation which follows the official Adobe patter. Frankly, it isn't worth it though. The ASDoc tool is buggy and unreliable. If it has difficulty finding an import, if an import isn't used, a comment is not correctly formatted, or you have your source code spread out in any sort of unexpected way, it simply breaks.

My company has lost over 50 developer hours (a few people tried to get a couple of different projects to work and failed) in an attempt to get around these limitations and our solution? We used NaturalDocs (A JavaDoc compiler). Is it perfect? No. Is it comparable to ASDoc in output? Sort of, it isn't as neat, and it would be nice if it treated things a little differently, but it works to display the documentation.