Thread (67 messages) 67 messages, 3 authors, 2018-01-31

Re: [PATCH v1 3/5] drivers/raw: introduce skeleton rawdev driver

From: Thomas Monjalon <hidden>
Date: 2018-01-16 10:34:50

16/01/2018 11:21, Shreyansh Jain:
On Monday 15 January 2018 04:24 AM, Thomas Monjalon wrote:
quoted
02/01/2018 13:57, Shreyansh Jain:
quoted
+struct skeleton_firmware {
+	struct skeleton_firmware_version_info firmware_version;
+	/**< Device firmware information */
+	enum skeleton_firmware_state firmware_state;
+	/**< Device state */
+};
+
+#define SKELETON_MAX_ATTRIBUTES 10
+#define SKELETON_ATTRIBUTE_NAME_MAX 20
+
+struct skeleton_rawdev_attributes {
+	char *name;
+	/**< Name of the attribute */
+	uint64_t value;
+	/**< Value or reference of value of attribute */
+};
+
+#define SKELETON_CAPA_FW_LOAD	0x0001
+/**< Device supports firmware loading/unloading */
+#define SKELETON_CAPA_FW_RESET  0x0002
+/**< Device supports firmware reset */
+#define SKELETON_CAPA_QUEUES    0x0004
+/**< Device support queue based communication */
Comment about the style. The style is important :)
You are always writing comments after the item.
Yes, I was trying to stick to single method - postfix.
quoted
When comments are on a separate line, I think it is preferred to write
them *before* the item they describe.
Consider this:

struct dummy {
     int a;  /**< a postfix comment */
     /**< a prefix comment */
     int b;
};

Personally, Even I prefer prefix when it comes to full line comments - 
but mixing prefix and postfix can lead to non-readable code.

Anyways - I was referring [1]

[1] 
http://dpdk.org/doc/guides/contributing/documentation.html#doxygen-guidelines

and it seems that I should change all to prefix in case any comment in 
the structure is not fitting into a single line.
I will do that.
OK thanks
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help