Context Navigation

← Previous Change
Next Change →

Changeset 4122410 in mainline for uspace/srv/hid

Timestamp:

2018-08-29T21:26:21Z (7 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

c8ea6eca

Parents:

46f7b64

Message:

Improve Doxygen documentaion

This is stil WiP. A number of libraries, drivers and services were
converted to using a more hierarchical and decentralized scheme when it
comes to specifying to which doxygen group they belong.

Location:

uspace/srv/hid

Files:

: 5 added
: 19 edited

compositor/doc/doxygroups.h (added)
console/doc/doxygroups.h (added)
input/doc/doxygroups.h (added)
input/gsp.h (modified) (1 diff)
input/layout/ar.c (modified) (1 diff)
input/layout/cz.c (modified) (1 diff)
input/layout/us_dvorak.c (modified) (1 diff)
input/layout/us_qwerty.c (modified) (1 diff)
output/ctl/serial.c (modified) (1 diff)
output/ctl/serial.h (modified) (1 diff)
output/doc/doxygroups.h (added)
output/gfx/font-8x16.c (modified) (1 diff)
output/gfx/font-8x16.h (modified) (1 diff)
output/output.c (modified) (2 diffs)
output/output.h (modified) (2 diffs)
output/port/chardev.c (modified) (1 diff)
output/port/chardev.h (modified) (1 diff)
output/port/ega.c (modified) (1 diff)
output/port/ega.h (modified) (1 diff)
output/port/kfb.c (modified) (1 diff)
output/port/kfb.h (modified) (1 diff)
output/proto/vt100.c (modified) (1 diff)
output/proto/vt100.h (modified) (1 diff)
remcons/doc/doxygroups.h (added)

Legend:

: Unmodified
: Added
: Removed

uspace/srv/hid/input/gsp.h

-              r46f7b64
+              r4122410
 /** @addtogroup inputgen generic
- * @brief       Generic scancode parser.
  * @ingroup  input
  * @{
  */
 /** @file
+ * @brief Generic scancode parser
  */

uspace/srv/hid/input/layout/ar.c

-              r46f7b64
+              r4122410
 /** @addtogroup input
- * @brief Arabic keyboard layout (Based on US QWERTY layout's code).
  * @{
+ */
+/** @file
+ * @brief Arabic keyboard layout (Based on US QWERTY layout's code)
  */

uspace/srv/hid/input/layout/cz.c

-              r46f7b64
+              r4122410
 /** @addtogroup input
- * @brief Czech QWERTZ layout.
  * @{
+ */
+/** @file
+ * @brief Czech QWERTZ layout
  */

uspace/srv/hid/input/layout/us_dvorak.c

-              r46f7b64
+              r4122410
 /** @addtogroup input
- * @brief US Dvorak Simplified Keyboard layout.
  * @{
+ */
+/** @file
+ * @brief US Dvorak Simplified Keyboard layout
  */

uspace/srv/hid/input/layout/us_qwerty.c

-              r46f7b64
+              r4122410
 /** @addtogroup input
- * @brief US QWERTY layout.
  * @{
+ */
+/** @file
+ * @brief US QWERTY layout
  */

uspace/srv/hid/output/ctl/serial.c

r46f7b64	r4122410
28	28	*/
29	29
30		/** @addtogroup ~~console~~
	30	/** @addtogroup output
31	31	* @{
32	32	*/

uspace/srv/hid/output/ctl/serial.h

-              r46f7b64
+              r4122410
  */
+/** @file
+/** @addtogroup output
+ * @{
  */

uspace/srv/hid/output/gfx/font-8x16.c

r46f7b64	r4122410
28	28	*/
29	29
30		/** @addtogroup ~~genarch~~
	30	/** @addtogroup output
31	31	* @{
32	32	*/

uspace/srv/hid/output/gfx/font-8x16.h

r46f7b64	r4122410
27	27	*/
28	28
29		/** @addtogroup ~~genarch~~
	29	/** @addtogroup output
30	30	* @{
31	31	*/

uspace/srv/hid/output/output.c

-              r46f7b64
+              r4122410
  */
+/** @addtogroup output
+ * @{
+ */
 #include <errno.h>
 #include <stddef.h>
 …
         return 0;
+}
+/** @}
+ */

uspace/srv/hid/output/output.h

-              r46f7b64
+              r4122410
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+/** @addtogroup output
+ * @{
  */
 …
 #endif
+/** @}
+ */