New Documentation System

[volkans80]

Hi,

I started to change documentation sytem and i want to know your opinion about.

http://www.isogenicengine.com/forum/viewtopic.php?f=8&t=543&sid=e9febde0162e379902e4d4b297778a65

Thanks,

[Irrelon]

Hey ya, can you describe a bit about it? How it is different, how it is better, what it solves etc. :)

Many thanks!

[volkans80]

Ok :)

• It is single page all process works with ajax.
• It is using tab system. We can open multiple documents at a time. (Also examples, videos or guides)
• Ready for integrate our examples, guides, videos. (I already make some examples for ige)
• We can design a home page for documentation. (I already make example home page)
• We can search any class name, method name, event name, property name on any time any page.
• We can define namespaces for classes and system hierarchically shows it like folders. (I already make namespaces for classes and i used your folder names as namespaces. But if there is better idea we can change it)
• We can make versioned documents. For example every released version can have own documentation.

When reading a documentation of class:

• You can view all methods, properties, events. Not only this classes also inherited classes.
• You can view all members with menu. (Quick list of all members)
• You can hide or show public, protected, private, inherited, accessor, deprecated, removed.
• You can view classes hierarchy, inherited mixins, requires, files.
• You can search and filter class members.
• You can view any method, property or events source code with one click. (Not only opening source code. It is opens source code and scrolls to method, property or events defined line.)
• You can use markdown in all descriptions like wiki.
• You can use examples in descriptions. Also if we configure it we can use runnable examples in descriptions.
• You can view all Types and click them to jump.
• You can describe all return types. For example if method returns a undefined new object you can also describe its members.

Hey Rob this list is my first remembered :) But i think you should see it. It is very good and very useful. My clone have this doc system. If you download it please specially look at IgeEntity, IgeEngine, IgeClass, IgeObject. Other classes are not reviewed but it looks acceptable.

https://github.com/volkans80/ige

[volkans80]

http://volkans80.github.io/ige/#!/api/Core.IgeEntity