Commit Graph

35 Commits

Author SHA1 Message Date
Peter Barker 27fadb2572 Tools: rstemit: render parameter information in h tables
Render ranges as "min - max"
2016-04-13 21:16:41 +10:00
Peter Barker 14b51080a9 Tools: remove erroneous space in rst output 2016-03-22 18:31:05 +11:00
Peter Barker 9f9e3843e0 Tools: formatting changes for rst parameter file 2016-03-21 20:56:49 +11:00
Peter Barker a8e9fc19b0 Tools: allow param parser to emit ReStructured Text 2016-03-17 16:10:11 +11:00
Don Gagne cae7ea0d13 Add @Volatile, @ReadOnly support 2016-03-17 10:58:05 +11:00
Don Gagne 07c0c6d519 autotest: Validate Range meta data for correctness 2015-12-27 16:10:43 +11:00
Andrew Tridgell 43d6060ba7 autotest: removed "Library Parameters" heading in autodocs 2015-06-16 10:01:03 +10:00
Randy Mackay fbec1e63ad autotest: fix typo in Bitmask keyword for autodocs 2015-06-05 09:19:26 +09:00
Randy Mackay 7c851b781b autotest: allow Bitmask keyword in autodocs 2015-06-04 21:31:41 +09:00
Andrew Tridgell b6ed86465b autotest: prioritise .cpp projects over .pde projects 2015-05-30 15:21:25 +09:00
Andrew Tridgell 337cd3d4a7 autotest: allow RebootRequired keyword in autodocs 2015-05-29 16:35:33 +10:00
Andrew Tridgell dfc7878b14 autotest: fixed cpp files for parameter parsing 2015-05-21 11:42:32 +10:00
Andrew Tridgell cd2898b149 autotest: removed old table of contents link in generated paramater docs 2015-02-19 15:58:30 +11:00
Aaron Curtis 068febda1f Tools: Fix broken duplicate check for adding new libraries to the data structure 2014-06-28 13:17:45 +10:00
Andrew Tridgell 4f33e4e114 autotest: fixed handling for wiki and xml generation 2013-09-12 10:01:30 +10:00
Andrew Tridgell bfd61fec15 param_metadata: support .pde files for parameter autodocs 2013-09-12 09:51:59 +10:00
Andrew Tridgell ceaa0c789c autotest: improved preamble in auto param docs 2013-05-30 12:36:05 +10:00
Andrew Tridgell 7eb40d151c autotest: added TOC link
thanks to Gary for the suggestion!
2013-05-30 12:19:24 +10:00
Andrew Tridgell afd2f4bc78 autotest: added advanced param warning and header to auto-docs 2013-05-28 10:11:56 +10:00
Andrew Tridgell e6891ebdab autotest: fixed escaping of html in wiki descriptions 2013-05-27 23:17:47 +10:00
Andrew Tridgell d510f8f722 autotest: added generation of Parameters.html for wordpress
this generates APM docs for wordpress
2013-05-27 08:25:24 +10:00
Andrew Tridgell 5818dce3d2 param_metadata: fixed parameter parsing for multi-parameter objects
also adds more error checking
2013-05-21 17:02:13 +10:00
Kevin Hester d3dad7afee autotest: add @User autodocs to the apm.pdef.xml as user=foo 2013-04-16 11:19:15 +10:00
Kevin Hester a86ede4270 autotest: APM xml docs should be named xml.pdef.xml
(not arduplane.pdef.xml)

pch: rebased pull request #188
2013-04-07 11:12:11 -07:00
Kevin Hester 9885cc7ed1 Docs: Add XML emit to param_parse.py. See below for more details...
I've refactored the param_parse tool to use various 'emitters'.  An emitter
can take parameter info and output it in a particular format.  Currently the
only supported emitters are the wiki and XML formats.

The goal of these changes is to create a standard machine readable description
of parameters - mainly for use by ground control stations, but it will also
enable spiffy scripting environments where code can refer symbolically to
vehicle parameters (reflectionish).

Open issue: Is there any sort of Ardupilot build id which can be included in
the generated XML?  That would ensure that we select the correct paramdefs
for the load on the target (possibly by asking the target for a SHA or
somesuch).  If that issue is resolved, then the filename for the XML
file should probably be something like:
arduplane-ca5742ac.pdef.xml.

It is worth noting that I've proposed a suffix of ".pdef.xml" for these file
types.  This facilitates automated file handling on Android devices.  On
Android you can register 'handlers' for particular file extensions and if
the user tries to open that extension in email or a web browser your app
will be given a chance to do something about it.  The 'outer' xml extension
will allow naive editors to know that at least this is an xml file.

I will include a sample of the XML format with the pull-request for this CL.
2013-03-10 17:47:42 +11:00
Andrew Tridgell 58a0cfc0b3 params: fixed ordering of vehicle parsing
this keeps it consistent in the wiki
2012-11-20 20:37:02 +11:00
Andrew Tridgell 4683df4a21 params: fixed parsing of value lists with -1 elements 2012-11-20 20:27:00 +11:00
Andreas M. Antonopoulos c0f8f6251b param_parser: input validation bug fix 2012-07-16 23:37:13 -07:00
Andreas M. Antonopoulos de64c05f8e param_parser: cosmetic
Arduplane: doc fixes
2012-07-08 21:45:26 -07:00
Andreas M. Antonopoulos 186a3e4f6a param_parser - better tolerance for missing parameters 2012-07-04 23:01:52 -07:00
Andreas M. Antonopoulos 2010d3aaa3 parameter metadata parser: better values formatting 2012-07-04 21:27:58 -07:00
Andreas M. Antonopoulos 425ef33b59 parameter metadata parser: escape wiki characters 2012-07-04 20:55:55 -07:00
Andreas M. Antonopoulos 9f6fb89392 parameter metadata parser, display improvements 2012-07-04 17:58:09 -07:00
Andreas M. Antonopoulos 453c1677b5 parameter metadata -> wiki, bug fixes 2012-07-04 17:42:38 -07:00
Andreas M. Antonopoulos c4b59a89da parameter metadata parser and wiki generator 2012-07-04 16:44:53 -07:00