Peter Robins
e4b5b3039a
Remove static button in docs sidebar if none
2014-06-15 14:00:02 -04:00
Peter Robins
72dd59f554
Remove olx and interfaces from docs sidebar
2014-06-07 09:46:05 -04:00
Peter Robins
470ef992b7
Apidoc readme: clarify exportable methods
2014-05-30 12:13:19 -04:00
Peter Robins
2aa97957cc
Apidoc readme: minor change
...
so comments rendered correctly
2014-05-24 12:40:45 +01:00
Andreas Hocevar
08cdeaacb4
Clean up api.js
2014-05-22 15:51:21 +02:00
Andreas Hocevar
e050c905e2
Do not include oli.* symbols in the inheritance chain
2014-05-22 15:48:46 +02:00
Andreas Hocevar
aaf21198d3
Document event stability even when there is no description
2014-05-15 23:02:01 +02:00
Andreas Hocevar
b348a4f8f9
Add some margin between the 'static' tag and the name
2014-05-15 20:29:46 +02:00
Andreas Hocevar
a75d944311
Allow custom events and do not collect events from methods
2014-05-15 20:25:26 +02:00
Andreas Hocevar
b2554cab41
Mark optional and repeatable arguments
2014-05-15 16:58:13 +02:00
Andreas Hocevar
fc88db53f6
Make types look the same everywhere
2014-05-15 16:57:47 +02:00
Andreas Hocevar
720052de12
New landing page
2014-05-15 16:54:33 +02:00
Tim Schaub
049531831c
Move stability and inherited indicators after names
2014-05-14 16:27:30 -06:00
Tim Schaub
8fbf67b7e6
Remove space between ol. and Name
2014-05-14 16:26:44 -06:00
Andreas Hocevar
81a85fe0e2
Merge pull request #2061 from eshon/master
...
Some suggested color changes to apidoc template items
2014-05-14 22:45:21 +02:00
Eva Shon
b8cef60036
Update main.less
2014-05-14 16:43:26 -04:00
Eva Shon
55b273686a
Update main.less
2014-05-14 16:41:57 -04:00
Andreas Hocevar
a613e01677
Only document arguments of exported constructors
2014-05-14 09:06:26 +02:00
Eva Shon
b4d316f224
some suggested color changes to template items
2014-05-13 13:25:07 -04:00
Andreas Hocevar
90ffde52f2
Make sure that links are clickable
...
Because we set a padding of 50px on anchorable elements to make
sure they are not obscured by the header, we need to raise the
z-index of links so they are not obscured by these paddings.
2014-05-09 10:03:17 -05:00
Andreas Hocevar
f95e23deeb
Do not hide the first word of returns
2014-05-09 10:02:13 -05:00
Frederic Junod
1b6a317bf9
Lower case the event name
2014-05-08 17:12:29 +02:00
Andreas Hocevar
564d3cda12
Fix anchor offsets for line numbers
2014-05-07 15:01:48 -05:00
Andreas Hocevar
0d4c7dc1fc
Better match the ol3 color theme
2014-05-07 08:40:02 -05:00
Andreas Hocevar
c57e9dc047
Better readable color for type links
2014-05-06 14:12:38 -05:00
Andreas Hocevar
e2c9dd279d
Switch to the Jaguar theme
...
In addition to a nicer layout, this adds a searchable sidebar
and a source code viewer.
2014-05-06 12:46:59 -05:00
Andreas Hocevar
3f2f7e3603
Fix indentation
2014-05-06 12:45:53 -05:00
Andreas Hocevar
959e14c31a
Handle observables and fires augments in plugins
...
This makes it easier to switch themes.
2014-05-06 10:14:28 -05:00
Andreas Hocevar
c2a9e95a37
Make sure anchors are not obscured by the header
2014-05-05 12:40:48 -05:00
Andreas Hocevar
5f54b45fa2
Add readme note about observable properties
2014-05-05 09:52:32 -05:00
Andreas Hocevar
61b732b8f7
Make sure that parent classes are not marked undocumented
2014-05-05 09:40:28 -05:00
Andreas Hocevar
b1126c9373
Inline events and also list method events with the class
2014-05-05 09:35:33 -05:00
Andreas Hocevar
52444b1366
Inherit events
2014-05-04 18:29:18 -05:00
Andreas Hocevar
b444714c55
No longer need to remove dead links
...
There should be no dead links any more, now that we include
doclets for the whole inheritance chain of a class.
2014-05-04 18:28:19 -05:00
Andreas Hocevar
ea5df18c72
Remove unused require
2014-05-04 14:51:06 -05:00
Andreas Hocevar
8ee9f7cb6a
Simplify the way we annotate observable properties
...
We no longer add observable annotations to the constructor.
Instead, we just mark getters (and for read/write properties
also setters) with an observable annotation.
2014-05-03 16:04:25 -04:00
Andreas Hocevar
0f072c0ec1
List subclasses for each class
...
With this change, we no longer need to link to implementations
or subclasses manually.
2014-05-03 15:32:39 -04:00
Andreas Hocevar
db5b2e284a
Do not remove classes that other classes inherit from
2014-05-03 12:41:52 +02:00
Andreas Hocevar
6cea9a9d9a
Avoid dead links
...
Because we remove doclets that are not part of the API, there
are cases where linkto will create a link to an undocumented
doclet. We now replace such links with the longname of the
doclet.
2014-05-03 12:41:52 +02:00
Andreas Hocevar
5a13488b11
Stop adding ObjectEvent links manually
...
Now that the links are removed from event annotations, we no
longer need to do this, because inheritance works.
2014-05-02 12:06:48 +02:00
Andreas Hocevar
d6722ddc6f
Mark undocumented doclets as undocumented
...
To give other plugins access to doclets that are not part of
the API, we have to mark them undocumented instead of removing
them. They will be removed by JSDoc before publishing anyway.
2014-05-02 12:06:48 +02:00
Andreas Hocevar
e7e1ef7534
Show inherited observable properties
2014-05-01 22:17:57 +02:00
Andreas Hocevar
25dd0127e9
Recursively document subparams and span table columns
2014-05-01 22:17:57 +02:00
Andreas Hocevar
7271b50d5a
Simplify fires annotations
2014-05-01 22:17:56 +02:00
Andreas Hocevar
f22aac1e22
Only use the inheritdoc plugin once
2014-05-01 22:17:56 +02:00
Andreas Hocevar
fbdbbfb7a7
Get rid of stability annotations and document stability with api
...
This change adds a stability value to the api annotation, with
'experimental' as default value.
enum, typedef and event annotations are never exportable, but
api annotations are needed there to make them appear in the
docs.
Nested typedefs are no longer inlined recursively, because the
resulting tables get too wide with the current template.
2014-04-29 09:53:07 -06:00
Andreas Hocevar
29b643c7b0
Inline object literals from olx.js
2014-04-29 09:53:07 -06:00
Andreas Hocevar
c17ac0cae3
Greatly simplify and document the usage of JSDoc
...
This commit simplifies the exports.js plugin so it only relies
on the stability notes to generate the documentation, which
completely decouples it from the exportable API.
As a rule of thumb, whenever something has an 'api' annotation,
it should also have a 'stability' annotation. A more verbose
documentation of ol3 specific annotation usage is available in
the new 'apidoc/readme.md' file.
This commit also modifies all source files to implement these
usage suggestions.
2014-04-29 09:53:06 -06:00
Andreas Hocevar
aaf6101d0f
Include symbols from oli.js using interface and implements tags
...
Instead of regex parsing, we define tags for interface and
implements.
2014-04-29 09:53:06 -06:00
Andreas Hocevar
b758d92790
Use symbols.json for determining the API
...
Also to get rid of regular expression parsing, instead of
collecting exports for observables from the source files, we use
the 'observable' annotations.
2014-04-29 09:53:06 -06:00
