Skip to content
Snippets Groups Projects
Commit 3661ae8d authored by Dean Camera's avatar Dean Camera
Browse files

Minor documentation corrections.

parent 5a4def74
No related branches found
No related tags found
No related merge requests found
...@@ -285,7 +285,7 @@ void DataflashManager_ReadBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceInf ...@@ -285,7 +285,7 @@ void DataflashManager_ReadBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceInf
} }
/** Writes blocks (OS blocks, not Dataflash pages) to the storage medium, the board Dataflash IC(s), from /** Writes blocks (OS blocks, not Dataflash pages) to the storage medium, the board Dataflash IC(s), from
* the a given RAM buffer. This routine reads in OS sized blocks from the buffer and writes them to the * the given RAM buffer. This routine reads in OS sized blocks from the buffer and writes them to the
* Dataflash in Dataflash page sized blocks. This can be linked to FAT libraries to write files to the * Dataflash in Dataflash page sized blocks. This can be linked to FAT libraries to write files to the
* Dataflash. * Dataflash.
* *
...@@ -386,7 +386,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress, ...@@ -386,7 +386,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
} }
/** Reads blocks (OS blocks, not Dataflash pages) from the storage medium, the board Dataflash IC(s), into /** Reads blocks (OS blocks, not Dataflash pages) from the storage medium, the board Dataflash IC(s), into
* the a preallocated RAM buffer. This routine reads in Dataflash page sized blocks from the Dataflash * the preallocated RAM buffer. This routine reads in Dataflash page sized blocks from the Dataflash
* and writes them in OS sized blocks to the given buffer. This can be linked to FAT libraries to read * and writes them in OS sized blocks to the given buffer. This can be linked to FAT libraries to read
* the files stored on the Dataflash. * the files stored on the Dataflash.
* *
......
...@@ -285,7 +285,7 @@ void DataflashManager_ReadBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceInf ...@@ -285,7 +285,7 @@ void DataflashManager_ReadBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceInf
} }
/** Writes blocks (OS blocks, not Dataflash pages) to the storage medium, the board Dataflash IC(s), from /** Writes blocks (OS blocks, not Dataflash pages) to the storage medium, the board Dataflash IC(s), from
* the a given RAM buffer. This routine reads in OS sized blocks from the buffer and writes them to the * the given RAM buffer. This routine reads in OS sized blocks from the buffer and writes them to the
* Dataflash in Dataflash page sized blocks. This can be linked to FAT libraries to write files to the * Dataflash in Dataflash page sized blocks. This can be linked to FAT libraries to write files to the
* Dataflash. * Dataflash.
* *
...@@ -386,7 +386,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress, ...@@ -386,7 +386,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
} }
/** Reads blocks (OS blocks, not Dataflash pages) from the storage medium, the board Dataflash IC(s), into /** Reads blocks (OS blocks, not Dataflash pages) from the storage medium, the board Dataflash IC(s), into
* the a preallocated RAM buffer. This routine reads in Dataflash page sized blocks from the Dataflash * the preallocated RAM buffer. This routine reads in Dataflash page sized blocks from the Dataflash
* and writes them in OS sized blocks to the given buffer. This can be linked to FAT libraries to read * and writes them in OS sized blocks to the given buffer. This can be linked to FAT libraries to read
* the files stored on the Dataflash. * the files stored on the Dataflash.
* *
......
...@@ -281,7 +281,7 @@ void DataflashManager_ReadBlocks(const uint32_t BlockAddress, ...@@ -281,7 +281,7 @@ void DataflashManager_ReadBlocks(const uint32_t BlockAddress,
} }
/** Writes blocks (OS blocks, not Dataflash pages) to the storage medium, the board Dataflash IC(s), from /** Writes blocks (OS blocks, not Dataflash pages) to the storage medium, the board Dataflash IC(s), from
* the a given RAM buffer. This routine reads in OS sized blocks from the buffer and writes them to the * the given RAM buffer. This routine reads in OS sized blocks from the buffer and writes them to the
* Dataflash in Dataflash page sized blocks. This can be linked to FAT libraries to write files to the * Dataflash in Dataflash page sized blocks. This can be linked to FAT libraries to write files to the
* Dataflash. * Dataflash.
* *
...@@ -382,7 +382,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress, ...@@ -382,7 +382,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
} }
/** Reads blocks (OS blocks, not Dataflash pages) from the storage medium, the board Dataflash IC(s), into /** Reads blocks (OS blocks, not Dataflash pages) from the storage medium, the board Dataflash IC(s), into
* the a preallocated RAM buffer. This routine reads in Dataflash page sized blocks from the Dataflash * the preallocated RAM buffer. This routine reads in Dataflash page sized blocks from the Dataflash
* and writes them in OS sized blocks to the given buffer. This can be linked to FAT libraries to read * and writes them in OS sized blocks to the given buffer. This can be linked to FAT libraries to read
* the files stored on the Dataflash. * the files stored on the Dataflash.
* *
......
...@@ -76,37 +76,37 @@ ...@@ -76,37 +76,37 @@
*/ */
#define CONTROL_LINE_OUT_RTS (1 << 1) #define CONTROL_LINE_OUT_RTS (1 << 1)
/** Mask for the DCD handshake line for use with the a NOTIF_SerialState class specific notification /** Mask for the DCD handshake line for use with the NOTIF_SerialState class specific notification
* from the device to the host, to indicate that the DCD line state is currently high. * from the device to the host, to indicate that the DCD line state is currently high.
*/ */
#define CONTROL_LINE_IN_DCD (1 << 0) #define CONTROL_LINE_IN_DCD (1 << 0)
/** Mask for the DSR handshake line for use with the a NOTIF_SerialState class specific notification /** Mask for the DSR handshake line for use with the NOTIF_SerialState class specific notification
* from the device to the host, to indicate that the DSR line state is currently high. * from the device to the host, to indicate that the DSR line state is currently high.
*/ */
#define CONTROL_LINE_IN_DSR (1 << 1) #define CONTROL_LINE_IN_DSR (1 << 1)
/** Mask for the BREAK handshake line for use with the a NOTIF_SerialState class specific notification /** Mask for the BREAK handshake line for use with the NOTIF_SerialState class specific notification
* from the device to the host, to indicate that the BREAK line state is currently high. * from the device to the host, to indicate that the BREAK line state is currently high.
*/ */
#define CONTROL_LINE_IN_BREAK (1 << 2) #define CONTROL_LINE_IN_BREAK (1 << 2)
/** Mask for the RING handshake line for use with the a NOTIF_SerialState class specific notification /** Mask for the RING handshake line for use with the NOTIF_SerialState class specific notification
* from the device to the host, to indicate that the RING line state is currently high. * from the device to the host, to indicate that the RING line state is currently high.
*/ */
#define CONTROL_LINE_IN_RING (1 << 3) #define CONTROL_LINE_IN_RING (1 << 3)
/** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host, /** Mask for use with the NOTIF_SerialState class specific notification from the device to the host,
* to indicate that a framing error has occurred on the virtual serial port. * to indicate that a framing error has occurred on the virtual serial port.
*/ */
#define CONTROL_LINE_IN_FRAMEERROR (1 << 4) #define CONTROL_LINE_IN_FRAMEERROR (1 << 4)
/** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host, /** Mask for use with the NOTIF_SerialState class specific notification from the device to the host,
* to indicate that a parity error has occurred on the virtual serial port. * to indicate that a parity error has occurred on the virtual serial port.
*/ */
#define CONTROL_LINE_IN_PARITYERROR (1 << 5) #define CONTROL_LINE_IN_PARITYERROR (1 << 5)
/** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host, /** Mask for use with the NOTIF_SerialState class specific notification from the device to the host,
* to indicate that a data overrun error has occurred on the virtual serial port. * to indicate that a data overrun error has occurred on the virtual serial port.
*/ */
#define CONTROL_LINE_IN_OVERRUNERROR (1 << 6) #define CONTROL_LINE_IN_OVERRUNERROR (1 << 6)
......
...@@ -286,7 +286,7 @@ void DataflashManager_ReadBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceInf ...@@ -286,7 +286,7 @@ void DataflashManager_ReadBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceInf
} }
/** Writes blocks (OS blocks, not Dataflash pages) to the storage medium, the board Dataflash IC(s), from /** Writes blocks (OS blocks, not Dataflash pages) to the storage medium, the board Dataflash IC(s), from
* the a given RAM buffer. This routine reads in OS sized blocks from the buffer and writes them to the * the given RAM buffer. This routine reads in OS sized blocks from the buffer and writes them to the
* Dataflash in Dataflash page sized blocks. This can be linked to FAT libraries to write files to the * Dataflash in Dataflash page sized blocks. This can be linked to FAT libraries to write files to the
* Dataflash. * Dataflash.
* *
...@@ -387,7 +387,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress, ...@@ -387,7 +387,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
} }
/** Reads blocks (OS blocks, not Dataflash pages) from the storage medium, the board Dataflash IC(s), into /** Reads blocks (OS blocks, not Dataflash pages) from the storage medium, the board Dataflash IC(s), into
* the a preallocated RAM buffer. This routine reads in Dataflash page sized blocks from the Dataflash * the preallocated RAM buffer. This routine reads in Dataflash page sized blocks from the Dataflash
* and writes them in OS sized blocks to the given buffer. This can be linked to FAT libraries to read * and writes them in OS sized blocks to the given buffer. This can be linked to FAT libraries to read
* the files stored on the Dataflash. * the files stored on the Dataflash.
* *
......
...@@ -285,7 +285,7 @@ void DataflashManager_ReadBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceInf ...@@ -285,7 +285,7 @@ void DataflashManager_ReadBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceInf
} }
/** Writes blocks (OS blocks, not Dataflash pages) to the storage medium, the board Dataflash IC(s), from /** Writes blocks (OS blocks, not Dataflash pages) to the storage medium, the board Dataflash IC(s), from
* the a given RAM buffer. This routine reads in OS sized blocks from the buffer and writes them to the * the given RAM buffer. This routine reads in OS sized blocks from the buffer and writes them to the
* Dataflash in Dataflash page sized blocks. This can be linked to FAT libraries to write files to the * Dataflash in Dataflash page sized blocks. This can be linked to FAT libraries to write files to the
* Dataflash. * Dataflash.
* *
...@@ -386,7 +386,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress, ...@@ -386,7 +386,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
} }
/** Reads blocks (OS blocks, not Dataflash pages) from the storage medium, the board Dataflash IC(s), into /** Reads blocks (OS blocks, not Dataflash pages) from the storage medium, the board Dataflash IC(s), into
* the a preallocated RAM buffer. This routine reads in Dataflash page sized blocks from the Dataflash * the preallocated RAM buffer. This routine reads in Dataflash page sized blocks from the Dataflash
* and writes them in OS sized blocks to the given buffer. This can be linked to FAT libraries to read * and writes them in OS sized blocks to the given buffer. This can be linked to FAT libraries to read
* the files stored on the Dataflash. * the files stored on the Dataflash.
* *
......
...@@ -285,7 +285,7 @@ void DataflashManager_ReadBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceInf ...@@ -285,7 +285,7 @@ void DataflashManager_ReadBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceInf
} }
/** Writes blocks (OS blocks, not Dataflash pages) to the storage medium, the board Dataflash IC(s), from /** Writes blocks (OS blocks, not Dataflash pages) to the storage medium, the board Dataflash IC(s), from
* the a given RAM buffer. This routine reads in OS sized blocks from the buffer and writes them to the * the given RAM buffer. This routine reads in OS sized blocks from the buffer and writes them to the
* Dataflash in Dataflash page sized blocks. This can be linked to FAT libraries to write files to the * Dataflash in Dataflash page sized blocks. This can be linked to FAT libraries to write files to the
* Dataflash. * Dataflash.
* *
...@@ -386,7 +386,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress, ...@@ -386,7 +386,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
} }
/** Reads blocks (OS blocks, not Dataflash pages) from the storage medium, the board Dataflash IC(s), into /** Reads blocks (OS blocks, not Dataflash pages) from the storage medium, the board Dataflash IC(s), into
* the a preallocated RAM buffer. This routine reads in Dataflash page sized blocks from the Dataflash * the preallocated RAM buffer. This routine reads in Dataflash page sized blocks from the Dataflash
* and writes them in OS sized blocks to the given buffer. This can be linked to FAT libraries to read * and writes them in OS sized blocks to the given buffer. This can be linked to FAT libraries to read
* the files stored on the Dataflash. * the files stored on the Dataflash.
* *
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment