Commit Graph

4228 Commits

Author SHA1 Message Date
Victor Woeltjen
851d0f0d63 [API] Clean up Composition API 2016-09-07 08:09:37 -07:00
Victor Woeltjen
5a129de73d [API] Clarify language 2016-09-06 16:32:54 -07:00
Victor Woeltjen
0cf634a412 [API] Add more front-page content 2016-09-06 16:30:05 -07:00
Victor Woeltjen
702d7acf64 [API] Begin adding front page content 2016-09-06 16:18:42 -07:00
Victor Woeltjen
69a500bf44 [API] Dedocument Selection
...and add a description to MCT#conductor
2016-09-06 16:07:49 -07:00
Victor Woeltjen
82e5b009e8 [API] Move Identifier typedef 2016-09-06 13:58:19 -07:00
Victor Woeltjen
aafd0731ec [API] Remove 'the API' section
...as this is now generated from JSDoc, more or less
2016-09-06 13:47:59 -07:00
Victor Woeltjen
c9705a5f2c [API] Normalize line length 2016-09-06 13:46:02 -07:00
Victor Woeltjen
7cc4a1262c [API] Proofread intro 2016-09-06 13:31:07 -07:00
Victor Woeltjen
02904a6081 [API] Link to openmct module in the preamble 2016-09-06 13:28:49 -07:00
Victor Woeltjen
7ce9bd969a [API] Telemetry JSdoc 2016-09-06 10:14:04 -07:00
Victor Woeltjen
8cafd2da7e Merge remote-tracking branch 'origin/api-tutorial/telemetry' into api-1110 2016-09-06 10:06:30 -07:00
Victor Woeltjen
6264ab75f3 Merge remote-tracking branch 'origin/api-tutorials' into api-1110
Conflicts:
	src/MCT.js
	src/api/composition/CompositionCollection.js
	src/api/composition/DefaultCompositionProvider.js
	src/api/objects/MutableObject.js
2016-09-06 10:03:59 -07:00
Victor Woeltjen
7a5cad20ec [API] Add JSDoc for Dialog 2016-09-06 09:58:08 -07:00
Victor Woeltjen
4de069b393 [API] JSDoc for Selection 2016-09-06 09:54:51 -07:00
Victor Woeltjen
70abd5c1f9 [API] Document start event 2016-09-06 09:47:06 -07:00
Victor Woeltjen
2a3a61da86 [API] Fix event memberofs in TimeConductor 2016-09-06 09:45:24 -07:00
Victor Woeltjen
018bd022cc [API] Document View API 2016-09-06 09:42:04 -07:00
Victor Woeltjen
4739b36bc3 [API] Add metadata to View jsdoc 2016-09-06 09:14:04 -07:00
Victor Woeltjen
c9b1035a6d [API] Document Type.check 2016-09-06 09:13:01 -07:00
Victor Woeltjen
6768328475 [API] Document MutableObject 2016-09-06 08:43:01 -07:00
Victor Woeltjen
60c179eac3 [API] Add missing parameter names 2016-09-06 08:32:18 -07:00
Victor Woeltjen
a20e8d69b5 [API] More Objects doc 2016-09-06 08:31:42 -07:00
Victor Woeltjen
1abcb248fe [API] Include API.md as main page 2016-09-06 08:13:26 -07:00
Victor Woeltjen
a8151f5f22 [API] Document CompositionProvider 2016-09-06 08:09:03 -07:00
Victor Woeltjen
cdf21f3763 [API] Mark Composition as instance method 2016-09-06 07:58:52 -07:00
Victor Woeltjen
341bceb4e2 [API] Document composition API 2016-09-06 07:57:44 -07:00
Victor Woeltjen
0470a02272 [API] Reference ObjectAPI 2016-09-02 16:04:38 -07:00
Victor Woeltjen
e3dc26c130 [API] Clean up docs 2016-09-02 15:25:28 -07:00
Victor Woeltjen
96c3d1cac2 [API] Use JSDoc config 2016-09-02 15:19:20 -07:00
Victor Woeltjen
2af778145d [API] Clean up JSDoc slightly 2016-09-02 15:16:11 -07:00
Victor Woeltjen
5743eeb33a [API] Reference EventEmitter 2016-09-02 15:03:12 -07:00
Victor Woeltjen
f06f714bdc [API] Document some public fields 2016-09-02 15:02:18 -07:00
Victor Woeltjen
d592bd1035 [API] Give up on borrows-style documentation 2016-09-02 14:58:06 -07:00
Victor Woeltjen
b5f62541ce [API] Add watch for API docs 2016-09-02 14:54:27 -07:00
Victor Woeltjen
33ced4bccf [API] Expose MCT on openmct 2016-09-01 15:51:25 -07:00
Victor Woeltjen
e37510dbab [API] Ignore internal API after processing 2016-09-01 15:13:52 -07:00
Victor Woeltjen
f27c41014d [API] JSDoc for openmct.start() 2016-09-01 14:50:18 -07:00
Victor Woeltjen
bd796f2beb [API] Simple constructor documentation 2016-09-01 14:44:24 -07:00
Victor Woeltjen
bcc32c76d0 [API] Module-level JSDoc 2016-09-01 14:42:55 -07:00
Victor Woeltjen
ff2ec6690a [API] Rename module to openmct 2016-09-01 14:35:52 -07:00
Victor Woeltjen
1e0fb3611d [API] Render API docs to HTML 2016-09-01 12:34:54 -07:00
Victor Woeltjen
1d4f36a7d9 [API] Include JSDoc for mct namespace only 2016-08-26 11:48:27 -07:00
Victor Woeltjen
0f96fbdd62 [API] Treat mct as a namespace 2016-08-26 11:31:56 -07:00
Victor Woeltjen
e05fb57fe4 [API] Quasi-sensible JSDoc starting point 2016-08-26 09:47:50 -07:00
Victor Woeltjen
185cdcab08 [API] Begin adding mct.js
...which will provide an instance of OpenMCT at startup,
as well as house documentation for entry point to public API.
2016-08-26 09:31:12 -07:00
Victor Woeltjen
50ccad5aaa [API] Rename MCT to OpenMCT 2016-08-26 09:26:12 -07:00
Victor Woeltjen
6a23df9454 [API] Add JSDoc for MCT 2016-08-25 14:54:07 -07:00
Victor Woeltjen
ab5b1d3754 [API] Add JSDoc task 2016-08-25 13:49:21 -07:00
Victor Woeltjen
b309f26b56 [API] Add gulp-jsdoc-to-markdown dep
...to aid in generating API docs as a measure of API completeness
and consistency, for #1110 and #1111
2016-08-25 13:38:44 -07:00