]> sigrok.org Git - libsigrok.git/commit - libsigrok.h
Doxygen: Various improvements in libsigrok.h.
authorUwe Hermann <redacted>
Sun, 21 Oct 2012 15:49:22 +0000 (17:49 +0200)
committerUwe Hermann <redacted>
Mon, 22 Oct 2012 09:56:18 +0000 (11:56 +0200)
commit3c0839d52475605d61ce385eda95f824fc448c88
treef0a539d933de65a12d42700890c0ac74857b659c
parent9c5332d2915ba374775196b7e3624857d320b60a
Doxygen: Various improvements in libsigrok.h.

 - Turn SR_OK/SR_ERR_* and SR_LOG_* into proper enums.

 - Use /**< Foo. */ for Doxygen comments that are on the same line as
   the (e.g.) enum entry they document. If the comment is not on the
   same line (but rather directly above the enum entry) a simple
   /** Foo. */ comment is sufficient.

 - Use /** */ instead of /* */ in some places, so that Doxygen actually uses
   the respective comments.

 - Various smaller cosmetic fixes or cleanups.
libsigrok.h