summaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorSascha Hauer <s.hauer@pengutronix.de>2014-06-17 10:27:03 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2014-06-26 10:09:52 +0200
commit98360be0fefd58bf27df03c47d887dd676a31d73 (patch)
tree76447f0ee3d99f3864bdfb9952178affb5dc9f76 /include
parent7b82f548580fb52023ed2116784632fd996a51fc (diff)
downloadbarebox-98360be0fefd58bf27df03c47d887dd676a31d73.tar.gz
barebox-98360be0fefd58bf27df03c47d887dd676a31d73.tar.xz
Documentation: remove doxygen documentation
The doxygen documentation is long outdated. Remove it. It will be replaced with sphinx based documentation later. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'include')
-rw-r--r--include/command.h4
-rw-r--r--include/driver.h26
-rw-r--r--include/i2c/i2c.h4
-rw-r--r--include/linux/mtd/mtd-abi.h4
-rw-r--r--include/linux/mtd/mtd.h4
-rw-r--r--include/spi/spi.h4
-rw-r--r--include/usb/ch9.h4
-rw-r--r--include/usb/composite.h4
-rw-r--r--include/usb/gadget.h4
-rw-r--r--include/usb/usb.h4
10 files changed, 0 insertions, 62 deletions
diff --git a/include/command.h b/include/command.h
index 347ad2f3ec..5d5bf53544 100644
--- a/include/command.h
+++ b/include/command.h
@@ -90,8 +90,6 @@ void barebox_cmd_usage(struct command *cmdtp);
#endif /* __ASSEMBLY__ */
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#define Struct_Section __attribute__ ((unused,section (".barebox_cmd")))
#define BAREBOX_CMD_START(_name) \
@@ -127,8 +125,6 @@ static const __maybe_unused char cmd_##_name##_help[] =
#define BAREBOX_CMD_OPTS(text) .opts = text,
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
int register_command(struct command *);
#endif /* __COMMAND_H */
diff --git a/include/driver.h b/include/driver.h
index ffc0cbaf77..53e1000067 100644
--- a/include/driver.h
+++ b/include/driver.h
@@ -28,32 +28,6 @@
#include <param.h>
-/**
- * @file
- * @brief Main description of the device/driver model
- */
-
-/** @page driver_model Main description of the device/driver model
- *
- * We follow a rather simplistic driver model here. There is a
- * @code struct device_d @endcode
- * which describes a particular device present in the system.
- *
- * On the other side a
- * @code struct driver_d @endcode
- * represents a driver present in the system.
- *
- * Both structs find together via the members 'type' (int) and 'name' (char *).
- * If both members match, the driver's probe function is called with the
- * struct device_d as argument.
- *
- * People familiar with the Linux platform bus will recognize this behaviour
- * and in fact many things were stolen from there. Some selected members of the
- * structs will be described in this document.
- */
-
-/*@{*/ /* do not delete, doxygen relevant */
-
struct filep;
struct bus_type;
diff --git a/include/i2c/i2c.h b/include/i2c/i2c.h
index f89fefbb27..a107f5edb7 100644
--- a/include/i2c/i2c.h
+++ b/include/i2c/i2c.h
@@ -19,8 +19,6 @@
#include <driver.h>
#include <linux/types.h>
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
/*
* struct i2c_platform_data - structure of platform data for MXC I2C driver
* @param bitrate Bus speed measured in Hz
@@ -153,8 +151,6 @@ extern int i2c_master_recv(struct i2c_client *client, char *buf, int count);
extern int i2c_read_reg(struct i2c_client *client, u32 addr, u8 *buf, u16 count);
extern int i2c_write_reg(struct i2c_client *client, u32 addr, const u8 *buf, u16 count);
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
extern struct bus_type i2c_bus;
static inline int i2c_driver_register(struct driver_d *drv)
diff --git a/include/linux/mtd/mtd-abi.h b/include/linux/mtd/mtd-abi.h
index c1ba55bd2d..c46605d5e3 100644
--- a/include/linux/mtd/mtd-abi.h
+++ b/include/linux/mtd/mtd-abi.h
@@ -7,8 +7,6 @@
#ifndef __MTD_ABI_H__
#define __MTD_ABI_H__
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include <asm-generic/div64.h>
struct erase_info_user {
@@ -183,6 +181,4 @@ static inline uint32_t mtd_user_div_by_eb(uint64_t sz,
return sz;
}
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
#endif /* __MTD_ABI_H__ */
diff --git a/include/linux/mtd/mtd.h b/include/linux/mtd/mtd.h
index 5f02aee2d6..1d33592fef 100644
--- a/include/linux/mtd/mtd.h
+++ b/include/linux/mtd/mtd.h
@@ -9,8 +9,6 @@
#ifndef __MTD_MTD_H__
#define __MTD_MTD_H__
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include <driver.h>
#include <errno.h>
#include <linux/types.h>
@@ -325,8 +323,6 @@ int mtd_all_ff(const void *buf, unsigned int len);
#endif /* CONFIG_MTD_DEBUG */
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
static inline int mtd_is_bitflip(int err) {
return err == -EUCLEAN;
}
diff --git a/include/spi/spi.h b/include/spi/spi.h
index b4358a84de..620e5e57b4 100644
--- a/include/spi/spi.h
+++ b/include/spi/spi.h
@@ -1,8 +1,6 @@
#ifndef __INCLUDE_SPI_H
#define __INCLUDE_SPI_H
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include <driver.h>
#include <linux/string.h>
@@ -431,8 +429,6 @@ static inline ssize_t spi_w8r8(struct spi_device *spi, u8 cmd)
return (status < 0) ? status : result;
}
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
extern struct bus_type spi_bus;
struct spi_master *spi_get_master(int bus);
diff --git a/include/usb/ch9.h b/include/usb/ch9.h
index adbe53341b..93223638f7 100644
--- a/include/usb/ch9.h
+++ b/include/usb/ch9.h
@@ -33,8 +33,6 @@
#ifndef __LINUX_USB_CH9_H
#define __LINUX_USB_CH9_H
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include <linux/types.h> /* __u8 etc */
/*-------------------------------------------------------------------------*/
@@ -798,6 +796,4 @@ enum usb_device_state {
*/
};
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
#endif /* __LINUX_USB_CH9_H */
diff --git a/include/usb/composite.h b/include/usb/composite.h
index 798fa110e7..379927a07d 100644
--- a/include/usb/composite.h
+++ b/include/usb/composite.h
@@ -17,8 +17,6 @@
#ifndef __LINUX_USB_COMPOSITE_H
#define __LINUX_USB_COMPOSITE_H
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
/*
* This framework is an optional layer on top of the USB Gadget interface,
* making it easier to build (a) Composite devices, supporting multiple
@@ -343,6 +341,4 @@ extern int usb_string_id(struct usb_composite_dev *c);
#define WARNING(d, fmt, args...)
#define INFO(d, fmt, args...)
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
#endif /* __LINUX_USB_COMPOSITE_H */
diff --git a/include/usb/gadget.h b/include/usb/gadget.h
index ff1509ca79..798b51b3ce 100644
--- a/include/usb/gadget.h
+++ b/include/usb/gadget.h
@@ -15,8 +15,6 @@
#ifndef __LINUX_USB_GADGET_H
#define __LINUX_USB_GADGET_H
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include <usb/ch9.h>
#include <malloc.h>
#include <errno.h>
@@ -899,6 +897,4 @@ extern struct usb_ep *usb_ep_autoconfig(struct usb_gadget *,
extern void usb_ep_autoconfig_reset(struct usb_gadget *);
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
#endif /* __LINUX_USB_GADGET_H */
diff --git a/include/usb/usb.h b/include/usb/usb.h
index 1a369d2eeb..4877e321bd 100644
--- a/include/usb/usb.h
+++ b/include/usb/usb.h
@@ -22,8 +22,6 @@
#ifndef _USB_H_
#define _USB_H_
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include <driver.h>
#include <usb/usb_defs.h>
#include <asm/byteorder.h>
@@ -516,8 +514,6 @@ struct usb_device_id {
#define USB_CTRL_SET_TIMEOUT 5000
#define USB_CTRL_GET_TIMEOUT 5000
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
enum usb_dr_mode of_usb_get_dr_mode(struct device_node *np,
const char *propname);