Changeset 4122410 in mainline for uspace/srv/hid/output

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/output

Files:

• ctl/serial.c (modified) (1 diff)
• ctl/serial.h (modified) (1 diff)
• doc/doxygroups.h (added)
• gfx/font-8x16.c (modified) (1 diff)
• gfx/font-8x16.h (modified) (1 diff)
• output.c (modified) (2 diffs)
• output.h (modified) (2 diffs)
• port/chardev.c (modified) (1 diff)
• port/chardev.h (modified) (1 diff)
• port/ega.c (modified) (1 diff)
• port/ega.h (modified) (1 diff)
• port/kfb.c (modified) (1 diff)
• port/kfb.h (modified) (1 diff)
• proto/vt100.c (modified) (1 diff)
• proto/vt100.h (modified) (1 diff)

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

@@ -28 +28 @@
  */
 
-/** @addtogroup console
+/** @addtogroup output
  * @{
  */

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

@@ -28 +28 @@
  */
 
-/** @file
+/** @addtogroup output
+ * @{
  */
 

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

@@ -28 +28 @@
  */
 
-/** @addtogroup genarch
+/** @addtogroup output
  * @{
  */

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

@@ -27 +27 @@
  */
 
-/** @addtogroup genarch
+/** @addtogroup output
  * @{
  */

uspace/srv/hid/output/output.c

@@ -27 +27 @@
  */
 
+/** @addtogroup output
+ * @{
+ */
+
 #include <errno.h>
 #include <stddef.h>
@@ -493 +497 @@
         return 0;
 }
+
+/** @}
+ */

uspace/srv/hid/output/output.h

@@ -25 +25 @@
  * (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
+ * @{
  */
 
@@ -72 +76 @@
 
 #endif
+
+/** @}
+ */

uspace/srv/hid/output/port/chardev.c

@@ -28 +28 @@
  */
 
-/** @file
+/** @addtogropu output
+ * @{
  */
 

uspace/srv/hid/output/port/chardev.h

@@ -27 +27 @@
  */
 
-/** @file
+/** @addtogroup output
+ * @{
  */
 

uspace/srv/hid/output/port/ega.c

@@ -27 +27 @@
  */
 
-/** @file
+/** @addtogroup output
+ * @{
  */
 

uspace/srv/hid/output/port/ega.h

@@ -27 +27 @@
  */
 
-/** @file
+/** @addtogroup output
+ * @{
  */
 

uspace/srv/hid/output/port/kfb.c

@@ -29 +29 @@
  */
 
-/** @file
+/** @addtogroup output
+ * @{
  */
 

uspace/srv/hid/output/port/kfb.h

@@ -27 +27 @@
  */
 
-/** @addtogroup fb
- * @ingroup fbs
+/** @addtogroup output
  * @{
- */
-/** @file
  */
 

uspace/srv/hid/output/proto/vt100.c

@@ -27 +27 @@
  */
 
-/** @file
+/** @addtogroup output
+ * @{
  */
 

uspace/srv/hid/output/proto/vt100.h

@@ -27 +27 @@
  */
 
-/** @file
+/** @addtogroup output
+ * @{
  */