Commit graph

40 commits

Author SHA1 Message Date
Ian Abbott
155529234a doc/funcref: fixed a couple of minor mark-up issues. 2013-07-23 17:43:19 +01:00
Ian Abbott
b39b8cb8a4 doc/funcref: Fix "Returns:" for comedi_to_physical.
There was a stray space before the "Returns:" heading so it wasn't
processed as intended.  Also, there was an empty line above it leading
to an empty paragraph in the DocBook funcref.xml.
2012-05-11 12:56:55 +01:00
Ian Abbott
d7e611cc6f doc/funcref: Add links between comedi_to_phys and comedi_set_global_oor_behavior. 2012-05-11 12:45:29 +01:00
Ian Abbott
168fcd6ed6 doc/funcref: Moved in comedi_set_global_oor_behavior
Moved function comedi_set_global_oor_behavior out of the deprecated
section as it is associated with the comedi_to_phys function.
2012-05-11 12:34:31 +01:00
Bernd Porr
cda5011a87 Moved comedi_to_phys and comedi_from_phys back to the main
section. Both comedi_to_phys and comedi_to_physical complement
each other. Comedi_to_phys is linear and very fast whereas
comedi_to_physical is more precise but requires polynomials
and calibration data.
2012-05-11 11:15:45 +01:00
Ian Abbott
1c64dcb1b5 doc/funcref: Some DocBook mark-up changes. 2012-05-08 16:51:49 +01:00
Ian Abbott
5392632a1c doc/funcref: Added missing comedi_data_read_n
There was a broken link to the comedi_data_read_n function from
elsewhere, so we'd better add a section for it.
2012-05-01 17:42:15 +01:00
Bernd Porr
0d8c6e9661 Comedilib.pdf can now be generated with
dblatex -t pdf ./comedilib.xml

There were two major issues in the comedilb.xml:
1) there were too many nested sections so that
   latex ran out of sub-sub-sub-sub-sections.
2) A section needs a title and can no longer
   exist without one. The first line
   of the textfiles contains now the title
   and will be inserted by mkref into the xml file.

todo: switch from xmlto to dblatex for the pdf generation
and re-enable it in the makefile.
2012-04-23 00:23:03 +01:00
Frank Mori Hess
758813e955 Added description of return value from comedi_internal_trigger(). 2008-03-28 21:11:49 +00:00
Frank Mori Hess
3a5c3a8fb0 Added some links to core function references, and fixed some bitrot.
Deprecated comedi_set_global_oor_behavior since it only affects
comedi_to_phys (which is already deprecated).
2008-02-08 21:41:32 +00:00
Frank Mori Hess
a0568092e7 Converted comedilib docs to docbook-xml 4.4, fixing a bunch of
parse errors along the way (mostly unclosed tags).
2008-01-24 01:32:41 +00:00
Frank Mori Hess
b3627840ac Added reference entries for new configuration instruction wrappers. 2008-01-17 17:03:01 +00:00
Frank Mori Hess
8e610500f3 Split function references into subsections. Always build docs in
$(srcdir).
2008-01-14 22:15:07 +00:00
Frank Mori Hess
624228b8fe Added a little more description of return value from
comedi_mark_buffer_read(), from Jan Gukelberger <g.u.g.i@gmx.de>.
2007-12-17 00:06:39 +00:00
Frank Mori Hess
a630001ef0 Fixed name of comedi_cleanup_calibration() 2007-11-13 03:18:32 +00:00
Frank Mori Hess
c1082cee65 Fixed comedi_get_cmd_generic_timed() by adding a chanlist_len
parameter.  Old version is still available in library, thanks to the
magic of the version_script.
2007-08-02 19:46:44 +00:00
Frank Mori Hess
34b9800e40 Added const qualifiers to some char* return values. Added new
experimental comedi_dio_bitfield2() function which works with
> 32 channels.  Only works properly with ni_65xx currently.
Will post a request for review by any interested
parties to list before I bother making the rest of the drivers
work with it.
2006-10-17 18:19:29 +00:00
Frank Mori Hess
4ccca1c790 Added description of SDF_SOFT_CALIBRATED flag. 2006-09-11 13:55:22 +00:00
Frank Mori Hess
97ab81dcbc Added entries for comedi_to_physical() and comedi_from_physical(). 2006-09-08 18:38:07 +00:00
Frank Mori Hess
f4e592b4aa Added entries for comedi_get_hardcal_converter() and
comedi_get_softcal_converter().  Clairified comedi_apply_calibration()
a little.
2006-09-08 14:53:48 +00:00
Ian Abbott
5706893a20 Applied patch from David MacMahon <davidm -at- astro -dot- berkeley -dot- edu>.
Add leading zeroes to subdevice flag values.
2006-07-13 12:45:26 +00:00
Frank Mori Hess
ceeb49162b added table for subdevice flags to comedi_get_subdevice_flags()
documentation
2005-03-16 22:34:38 +00:00
Frank Mori Hess
2a720182e4 added comedi_dio_get_config() 2005-03-06 17:42:56 +00:00
Frank Mori Hess
9f6b16e004 added comedi_mark_buffer_written() (untested) 2005-01-10 00:46:28 +00:00
Frank Mori Hess
524f2090f4 added description of comedi_command_test() return values 2004-01-18 21:35:50 +00:00
Frank Mori Hess
a03c337cdb trying to improve calibration docs 2003-12-03 02:43:22 +00:00
Frank Mori Hess
ee428c99bc typo 2003-09-03 03:49:12 +00:00
Frank Mori Hess
66ab57bca1 marked sv_ functions as deprecated 2003-08-11 20:05:06 +00:00
Frank Mori Hess
b9f2b7d2fe undoing funcref regressions 2003-07-08 22:39:23 +00:00
David Schleef
d70d0eef2c Much fixage and new text from Herman. 2003-07-07 22:34:18 +00:00
Frank Mori Hess
49e17577df fixed return value for comedi_dio_config() entry 2003-06-06 05:01:08 +00:00
David Schleef
7e02472797 Change return value of comedi_data_{read|write}() 2003-06-04 04:15:02 +00:00
Frank Mori Hess
10045b2f61 added entries for additional calibration functions 2003-05-08 00:35:19 +00:00
Frank Mori Hess
0536b89f42 added return value for comedi_apply_calibration() 2003-03-06 19:04:18 +00:00
Frank Mori Hess
fb2bf948b2 Changed comedi_set_calibration() to comedi_apply_calibration(), and
made it much faster, it takes <100msec to run instead of >1sec.
It requires linking to libperl now (hope that's
okay).  Renamed DEBUG() and _() in libinternal.h to COMEDILIB_DEBUG()
and GETTEXT() in order to avoid conflicts with perl headers.
2003-03-04 00:41:10 +00:00
Frank Mori Hess
fc3cc45a16 added documentation for comedi_set_calibration() 2003-03-01 01:52:32 +00:00
Frank Mori Hess
f0e92b1322 added documentation for comedi_data_read_delayed() and comedi_data_read_hint()
because I'm sick of anwering questions about why comedi_data_read() returns
inaccurate values.
2002-11-18 23:49:57 +00:00
David Schleef
086659fc59 fix typo on comedi_open 2002-09-25 01:08:16 +00:00
David Schleef
427f10a77a Added some functions 2002-05-01 19:24:27 +00:00
David Schleef
0be5b00513 Move documentation ported to DocBook-3.1 out of docbook directory. 2002-01-21 15:32:42 +00:00
Renamed from doc/docbook/funcref (Browse further)