Éric Lemoine
b6b9f25b04
Add a Create Custom Builds tutorial
2015-04-07 16:55:38 +02:00
Björn Harrtell
421db6783f
Browserify tutorial
2015-04-05 13:08:46 +02:00
Éric Lemoine
953b8ff86f
Update the tutorials index
2015-04-04 22:44:29 +02:00
Éric Lemoine
6705a34358
Add "closure" tutorial
...
Tutorial describing how to compile application and OpenLayers together.
2015-04-04 22:43:42 +02:00
Marc Jansen
1940f33c43
Add a FAQ document.
2015-04-02 17:20:07 +02:00
Andreas Hocevar
9b4cb96502
Clarify where to ask questions
2015-03-23 14:14:34 +01:00
Tim Schaub
fc13499f31
Using the openlayers.org domain
2014-08-28 16:15:41 -06:00
Tim Schaub
d846fbc0b4
Correct link to API docs
2014-07-24 14:32:34 -06:00
Peter Robins
b945147950
Update introduction tutorial
2014-07-24 11:08:20 +00:00
Peter Robins
90f2f96797
Introduction tutorial
2014-07-03 05:14:25 -04:00
Tim Schaub
47d37fabea
Rename ol.View2D to ol.View
2014-06-27 09:59:39 -04:00
Bart van den Eijnden
bf8e949955
Move workshop reference to doc index
2014-05-27 09:17:52 +02:00
Bart van den Eijnden
17ecccdb23
Put reference to workshop in QuickStart
2014-03-31 21:03:10 +02:00
Frederic Junod
431ef6ef07
Add newline in quick start doc
2014-02-27 09:23:23 +01:00
Frederic Junod
2f73816916
Fix path to ol.css
2014-02-27 09:23:00 +01:00
ThomasG77
af2fb1ad42
Update quickstart.hbs
...
Fix on the fix ;) because a removed new via the Github UI
2014-01-09 23:04:15 +01:00
ThomasG77
923bb3f36c
Update quickstart.hbs
...
Fix the error due to outdated ol.source.MapQuestOpenAerial() because of this feedback https://groups.google.com/forum/#!topic/ol3-dev/6xi2n7nMg8k on the ML
2014-01-09 22:55:34 +01:00
Tim Schaub
394dfa297a
Link to API docs
2013-09-24 15:14:50 +02:00
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
Tim Schaub
a9b0e6239b
Link to latest, fenced code blocks
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
Frederic Junod
f07294698a
Include ol.css in doc/quickstart.hbs
2013-09-24 11:15:26 +02:00
Tim Schaub
aec0c0d9af
Adding YAML frontmatter
...
This will be parsed by the website build task
2013-09-24 10:39:34 +02:00
Tim Schaub
2f2ee22831
Moving quickstart to doc directory
2013-09-24 10:37:43 +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
Frederic Junod
88f938ea47
Remove social-links.js script from examples and doc
2013-09-23 13:58:12 +02:00
Marc Jansen
67f2e57635
Fix spelling on API-doc index page.
2013-09-18 13:48:47 +02:00
Tim Schaub
3b20cc7b53
Rename ol.Projection to ol.proj.Projection
2013-09-15 22:01:56 -06:00
Frederic Junod
03e2f1a903
Add links to Proj4js and CONTRIBUTING.md
2013-09-09 12:07:16 +02:00
Tim Schaub
e1a2c72587
Adjective -> adverb
2013-06-27 16:01:22 -06:00
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
12cd3672bc
Remove "Inherited from" for non-API parents
2013-04-10 15:06:12 +02:00
ahocevar
71c32d3554
Don't use the undocumented property before it is set
...
This actually avoids addition of params of symbols that are not
part of the API.
2013-04-10 13:59:32 +02:00
ahocevar
7a50295c49
Making @elemoine and GitHub happy
...
Reminder to self: everyone wants a new line at the end of a
file.
2013-04-10 13:18:22 +02:00
ahocevar
423ba5c0e4
A few lines explaining what the exports.js plugin does
2013-04-10 11:04:39 +02:00
ahocevar
6f94ec6fe7
Adding params of API symbols to the API
...
This makes the API docs complete. What still needs to be
documented is API events, but this deserves a separate pull
request.
2013-04-10 10:57:36 +02:00
ahocevar
551a5f06ff
Nicer way to fix @inheritDoc
2013-04-10 01:45:21 +02:00
ahocevar
2fd185c966
Only document the exported API, not every symbol
...
There is more work to be done, because this filters out more
than desired, and we don't have events documented yet.
2013-04-10 01:44:40 +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
Tom Payne
18fdb66437
Update jsdoc template to be compatible with latest version of jsdoc3
2013-01-03 12:15:30 +01: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
