Commit Graph

6 Commits

Author SHA1 Message Date
ahocevar
9e274a61db Fixing typo 2013-09-24 15:06:22 +02:00
Tim Schaub
5c98a47581 Bare bones index pages 2013-09-24 14:57:58 +02:00
ahocevar
d1c0665926 Adding heading 2013-09-24 13:46:14 +02:00
ahocevar
3adc46ae4a Adding basic concepts tutorial 2013-09-24 13:28:42 +02:00
Tim Schaub
4def0c6a84 Differentiating doc from apidoc
This renames the doc task to apidoc.  The apidoc delegates to jsdoc3 currently.  We will have additional documentation that is not built by jsdoc3.  It makes sense to reserve the more general 'doc' name for building all documentation (not just apidoc).
2013-09-23 23:58:25 +02:00
ahocevar
e042c5701a Enabling Markdown and other JSDoc improvements
This change enables GitHub flavored markdown for APIdoc
comments. The code example in map.js shows how to use markdown
for code snippets. doc/index.md is now included again as start
page for the docs. Everything in the doc/tutorials directory
will also be added to the docs as tutorial. As an example, I
moved the ol3.md file with the architecture to the tutorials
directory.

Currently properties and methods annotated with @inheritDoc
or @override won't be documented at all. This is a known issue,
so I added a custom JSDoc plugin with a hack to avoid this.
2013-04-04 11:53:12 +02:00