Commit Graph

13 Commits

Author SHA1 Message Date
ahocevar
f9281ac619 Docs align better with examples when not using a container 2013-04-14 09:19:40 +02:00
ahocevar
6440ce5ea0 Removing the timestamp
When auto-generating the website using grunt in the
openlayers.github.io repo, we do not need to publish new docs
every time grunt is run, just because the timestamp is updated.
2013-04-13 18:23:31 +02:00
ahocevar
bbc20f505b container-fluid is a class, not an id 2013-04-12 20:55:57 +02:00
ahocevar
6c5377eebe Creating a resources folder for use by examples and API docs 2013-04-04 15:18:15 +02:00
ahocevar
b4ce430bfb Making social links work 2013-04-04 14:25:24 +02:00
ahocevar
9f2ff48444 Use bootstrap layout and css from examples
I'm sure this can be made much prettier still, but at least we
have a common theme with the examples now.
2013-04-04 11:53:12 +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
augustus
64a252093c Taking over new template from jsdoc but keep modifications by OpenLayers as much as possible 2012-10-31 09:39:55 +01:00
Tim Schaub
5eb5715530 More longname display. 2012-09-24 18:23:19 +02:00
Tim Schaub
2b307ef6a9 Replace opt_ prefix with (Optional) in description. 2012-09-24 18:23:19 +02:00
Tim Schaub
f2c05bdf0f Remove "arguments" column from params table. 2012-09-24 18:23:19 +02:00
Tim Schaub
99e58cb8e0 Stylesheet to hide protected members.
Source tags are also hidden here as they only provide the file name and not the complete path.  This should be fixed in JSDoc 3.
2012-09-24 18:23:19 +02:00
Tim Schaub
57d75ace5d Adding a JSDoc 3 template. 2012-09-24 16:59:27 +02:00