Commit Graph

15 Commits

Author SHA1 Message Date
Uwe Hermann 82b9f3d116 Doxygen: Properly mark a few symbols as private.
(otherwise these end up in the API docs)

Remove all @internal markings, only use @private where needed.
2020-03-25 20:10:24 +01:00
Gerhard Sittig 18037e79f1 doc: update manual driver addition in the HACKING document
Build support has changed to use linker sections for driver registration.
Update the subsection in the HACKING document which discusses the manual
addition of device drivers, to match what the new-driver script does for
driver authors.
2019-06-02 20:39:01 +02:00
Uwe Hermann b4698e4d61 HACKING: Update URL to Linux kernel coding style. 2017-06-06 14:41:55 +02:00
Uwe Hermann 8626feaeb5 HACKING: Improve description of Doxygen conventions. 2016-12-20 17:51:36 +01:00
Uwe Hermann 4a94c27d95 HACKING: Prefer git pull requests over mailing list patches.
Also, drop the reference to gitorious.org (no longer available).
2016-08-29 00:25:19 +02:00
Uwe Hermann c7e4556258 HACKING: Document the new malloc related guidelines. 2014-11-12 16:35:05 +01:00
Uwe Hermann 487c23fc99 HACKING: Minor updates. 2014-11-12 16:35:05 +01:00
Uwe Hermann ef1020f9cb HACKING: Updates, some additions. 2013-11-04 01:14:56 +01:00
Uwe Hermann 9fb5f2dfa6 Doxygen: Add @since markers.
Add @since tags to some (not all yet) public API functions, to document
in which release they were added (and/or in which release there were
API changes).

Document the @since usage in HACKING.

Also, add Doxygen docs for the functions in version.c.
2013-04-16 12:37:54 +02:00
Uwe Hermann 79bb0e97d5 Add a testsuite for libsigrok.
This adds a suite of unit tests for libsigrok. It uses the 'Check'
tool/library (apt-get install check) to run the tests.

The configure tool tries to find libcheck. If it succeeds, a
"make check" will run all tests. Otherwise, none of the tests will
be built and "make check" will not run any tests.

This also means that users who don't have 'check' installed will still
be able to build and install libsigrok just fine.
2013-03-09 11:55:43 +01:00
Uwe Hermann f18297a5fd HACKING: Document enum setup. 2012-11-02 19:05:53 +01:00
Uwe Hermann 2bba3dd3a8 HACKING: "Adding a new hardware driver" chapter. 2012-10-25 23:42:20 +02:00
Uwe Hermann b4bd70889f Doxygen: Mark non-public stuff for exclusion.
- /** @private */ can be used for functions, and /** @cond PRIVATE */ and
   /** @endcond */ for variables or #defines.

 - Document the above in HACKING.
2012-10-22 11:56:17 +02:00
Uwe Hermann 8ed262509f HACKING: Cosmetics. 2012-10-16 14:48:39 +02:00
Uwe Hermann a2353f6051 Re-add HACKING file after repo split. 2012-10-16 12:19:36 +02:00