Doxygen update

git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@428 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
dvl
2018-01-15 11:40:43 +00:00
parent 15ab232e82
commit cfb55967c7
12 changed files with 111 additions and 1 deletions

View File

@@ -148,6 +148,7 @@ struct MAX5715
* MAX5715_construct
* Constructs the MAX5715 instance into argument self.
*
* @memberof MAX5715
* @param self The MAX5715 object to initialize
* @param device The IODevice that should be used for
* communication with the MAX5715
@@ -165,6 +166,7 @@ extern ErrorStatus MAX5715_construct(struct MAX5715* self, const struct IODevice
* MAX5715_destruct
* Destructs the MAX5715 instance in argument self
*
* @memberof MAX5715
* @param self
*
* @return ErrorStatus SUCCESS if destruction was successful
@@ -196,6 +198,7 @@ extern ErrorStatus MAX5715_getSpiParameters(struct SpiParameters* parameters);
* Sends a command to MAX5715 instance in argument self with the command in
* argument command
*
* @memberof MAX5715
* @param self The MAX5715 instance
* @param command The command to be sent
*
@@ -212,6 +215,7 @@ extern ErrorStatus MAX5715_sendCommand(const struct MAX5715* self, uint8_t comma
* MAX5715Channel_construct
* Constructor for one of the channels on the MAX5715 DAC
*
* @memberof MAX5715
* @param self The channel object to initialize
* @param parent The parent object that the channel belongs
* to
@@ -230,6 +234,7 @@ extern ErrorStatus MAX5715Channel_construct(struct MAX5715_DAC* self, struct MAX
* MAX5715Channel_setValue
* Sends value to the DAC channel in self
*
* @memberof MAX5715
* @param self The DAC object
* @param value Value to write
*