Commit Graph

46 Commits

Author SHA1 Message Date
Daniel Reiter ce4e6d49f5 Fix github line links on jsdoc pages
Github line links only work with a capital `L`.
2016-08-02 11:05:10 -05:00
Andreas Hocevar 0dca194525 Handle types in arrays etc. 2016-06-04 00:27:25 +02:00
Andreas Hocevar 9e980663ee Remove api annotations from typedefs in olx.js 2016-06-03 10:38:55 +02:00
Andreas Hocevar eddd006fcf Document typedefs and enums used by API symbols
It is no longer necessary to add api annotations to typedefs and enums
that are used by API symbols.
2016-06-03 09:28:53 +02:00
Peter Robins 3b1c76a1da Correct typo in config/jsdoc/api/readme.md 2016-06-02 15:29:41 +01:00
Peter Robins 1a1d55d54e Add API policy to docs landing page 2016-05-17 14:27:12 +00:00
Andreas Hocevar e74434299e Fix incorrect source links 2016-05-12 18:51:54 +02:00
Andreas Hocevar 0d2b833e06 Use a div instead of alert for version warning
With this change, it is also no longer necessary to display the version in the
navigation bar. The accidently removed doctype is also brought back.
2016-05-12 17:13:44 +02:00
Andreas Hocevar d59ace1a61 Improve code readability with better comments 2016-05-11 15:46:39 +02:00
Andreas Hocevar d27ea0974e Fix source links, display version and warn about outdated docs 2016-05-11 12:45:58 +02:00
Andreas Hocevar 34139f4dce Fix apidoc landing page markup 2015-12-17 15:13:26 +01:00
Andreas Hocevar d9bb3adbe8 Improve vector tile related docs 2015-12-11 12:01:24 +01:00
Frederic Junod 7149113ab6 Remove unused files 2015-12-01 15:50:51 +01:00
Tim Schaub 34dd7b76b1 Use jsdoc@3.4.0 2015-11-17 18:04:16 -07:00
Tim Schaub 85ca4e1888 Update JSDoc to get async publish support 2015-10-31 13:30:30 -06:00
Michael Kalbermatten 9543cc10dd Remove invalid link to featureOverlay in API doc 2015-09-17 11:12:54 +02:00
Marc Jansen da627dda4b Merge pull request #4079 from marcjansen/mark-required-options
Automatically mark required options in API-docs
2015-09-15 16:13:36 +09:00
Björn Harrtell 31f2e334cf Reinstate inheritdoc to fix #4082 2015-09-09 07:43:22 +02:00
Marc Jansen 0a99d0f211 Automatically mark required options in API-docs 2015-09-03 16:44:12 +02:00
Tim Schaub 6dc7f2cfec Remove footer with timestamp 2015-08-07 11:22:07 -06:00
Björn Harrtell 6812de6a77 Upgrade JSDoc to 3.3.2 and remove obsoleted plugins 2015-08-04 22:04:15 +02:00
Andreas Hocevar 3595c2cce7 Document change events properly
With this change, the generic 'change' event is properly documented, as
all other events. It is no longer necessary to annotate `@fires change` for
every ol.Observable subclass.
2015-07-18 15:27:16 +02:00
Frederic Junod 00ce2f0f58 Remove dead link in api doc
Fixes #3596
2015-04-20 15:07:39 +02:00
Tim Schaub 8fd2e9f79f Untangle resources and put built examples in the build dir 2015-04-17 06:22:38 -06:00
Tim Schaub e5c6915761 Update documentation 2015-04-07 08:35:48 -06:00
Tim Schaub 05c1e973a3 Merge pull request #3415 from malaretv/stable-only-off
Stable Only unchecked by default.
2015-04-03 20:08:16 +02:00
Andreas Hocevar da9de6ef1b Merge pull request #3456 from klokan/newmenu
Updated menu on the JSDOC template (non-responsive)
2015-04-02 20:55:59 +02:00
Tim Schaub 44ad7ce30a Update doc on using @api annotation 2015-04-02 16:23:54 +02:00
Petr Pridal f47009447b Retina ol logo 35px (70px) for the JSDOC template 2015-04-02 08:43:26 +02:00
Petr Pridal 4427d0ba42 Updated menu on the JSDOC template (non-responsive) 2015-04-01 19:42:57 +02:00
vmalaret 4daf08ec1d Rename flag to 'stableonly' 2015-04-01 09:26:17 +02:00
vmalaret 3576f8b793 Stable Only unchecked by default in docs.
Having it on by default makes it difficult
for new users to find commonly used functionality.
2015-03-30 10:37:50 +02:00
Andreas Hocevar 4862a8c897 Create github source links 2015-03-23 16:08:36 +01:00
Tim Schaub 4b423fca16 Exclude source files from docs 2014-12-22 17:01:01 -05:00
Andreas Hocevar 4714c9b380 Fix typo in selector 2014-11-18 16:37:18 +01:00
Tim Schaub 39010238b9 Make stability checkbox sticky 2014-11-11 20:06:26 -08:00
Tim Schaub d4658837e2 Use toggleClass instead of addClass and removeClass 2014-11-06 10:42:40 -07:00
Andreas Hocevar 1d221f8166 Add ability to filter out unstable Fires items 2014-11-06 10:32:17 -07:00
Tim Schaub 02bfa42736 List events fired in the navigation 2014-11-03 16:52:17 -07:00
Éric Lemoine ad83f83f2c To do call toLowerCase when forming a change:property event 2014-09-18 18:44:45 +02:00
Tim Schaub 61d759acc7 Add unstable class to typedefs in navigation menu 2014-08-24 18:35:18 -06:00
Tim Schaub 79efcc78a5 Add unstable class to member definitions 2014-08-24 18:31:23 -06:00
Tim Schaub a8999f601b Hide unstable items by default, provide checkbox for toggling 2014-08-22 17:30:29 -06:00
Tim Schaub ecaedff890 Add "unstable" class to unstable items
This also removes the events from the sidebar.  These are repeated on the main page and only add unnecessary length to the sidebar.
2014-08-22 17:28:50 -06:00
Tim Schaub 787688ef33 Copy stability from doclet to observable 2014-08-22 17:27:29 -06:00
Tim Schaub f17c33f631 Rename buildcfg to config 2014-08-22 07:28:05 -06:00