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.
This commit is contained in:
ahocevar
2013-03-28 21:39:58 +01:00
parent 19e6569b69
commit e042c5701a
9 changed files with 208 additions and 3 deletions

View File

@@ -180,7 +180,7 @@ function buildNav(members) {
if (members.tutorials.length) {
nav += '<h3>Tutorials</h3><ul>';
members.tutorials.sort(byLongName).forEach(function(t) {
nav += '<li>'+tutoriallink(t.longname)+'</li>';
nav += '<li>'+tutoriallink(t.name)+'</li>';
});
nav += '</ul>';