Commit Graph

123 Commits

Author SHA1 Message Date
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
Tim Schaub b73ffbdc7c Hide source tags (until we get the full path). 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
Tom Payne 1c344ffa9f s/LayerView/LayerRendererOptions/ 2012-07-11 17:20:08 +02:00
Tom Payne 5494c36748 Sort functions alphabetically 2012-07-11 17:20:08 +02:00
Tom Payne 391b5906bc s/getTileResolution/getTileCoordResolution/g 2012-07-11 17:20:07 +02:00
Tom Payne 58e9ba322e Replace corner with xEast/ySouth 2012-07-11 17:20:07 +02:00
Tom Payne 24ba87bf92 s/yield/forEach/ 2012-07-11 17:20:07 +02:00
Tom Payne abb49a899a Add ol.TileBounds.forEachTileCoord 2012-07-11 17:20:07 +02:00
Tom Payne ff34400d96 Add ol.TileCoord.clone 2012-07-11 17:20:07 +02:00
Tom Payne 4ff6f03834 s/getTileBounds/getExtentTileBounds/ 2012-07-11 17:20:07 +02:00
Tim Schaub c56fce2be8 Attempting to clarify. 2012-07-11 17:20:06 +02:00
Tom Payne 8014f68719 Use goog.math.Bounds for extents 2012-07-11 17:20:05 +02:00
Tom Payne 25d67e670f Layers should always have an extent 2012-07-11 17:20:05 +02:00
Tom Payne dc2993b61d Add ol.Camera 2012-07-11 17:20:05 +02:00
Tom Payne 9f0738aa99 Add ol.TileCoord 2012-07-11 17:20:05 +02:00
Éric Lemoine 6f1f9922cc more structure in doc/ol3.md 2012-07-11 17:12:37 +02:00
Éric Lemoine 3efa392d1f ol3.md updates 2012-07-11 17:12:37 +02:00
Éric Lemoine c07d0c668d change ol3 doc from txt to markdown 2012-07-11 17:12:37 +02:00
Éric Lemoine 1bd975bc23 add design assertions to the doc/ol3.txt doc 2012-07-11 17:12:37 +02:00
Tom Payne 2474429f8c Add initial architecture draft 2012-07-11 17:12:37 +02:00
Éric Lemoine 2cc0090f81 move the licenses dir to the root of the repo 2012-03-29 21:59:58 +02:00
Éric Lemoine 6b04ff1c94 move authors.txt to the root of the repo 2012-03-29 21:58:54 +02:00
Éric Lemoine 5f4519b378 remove doc/customization and doc/readme.txt 2012-03-29 21:57:42 +02:00
Peter Robins 2f3f849597 Remove doc/walkthru.html 2012-02-28 12:14:43 +00:00
Marc Jansen 91f610f19c revert my commit rights test (dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf) 2011-09-20 05:50:45 +02:00
Example User b2ea600466 testing commit rights
git-svn-id: http://svn.openlayers.org/trunk/openlayers@12400 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
2011-09-20 01:10:14 +00:00
Marc Jansen 98f52eadde Adding various trunk commiters to the authors list. No functional change.
git-svn-id: http://svn.openlayers.org/trunk/openlayers@11985 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
2011-05-20 20:16:01 +00:00