I2S documentation

[Bendix]

Thank you for pointing me in the right direction!
I'll give it a try as soon as I can

[kisielk]

So I'm also looking at using I2S and was browsing the documentation and had a question:

How come on http://chibios.sourceforge.net/docs3/ha ... onfig.html the last two fields of the struct (i2scfgr and i2spr) aren't shown?

I'm entirely new to ChibiOS so it's possible I'm missing something in how the documentation is laid out.

[Giovanni]

Hi,

The documentation only reports those fields that are architecture-independent. Those two fields are STM32-specific and, note, are register names, the documentation is the STM32 Reference Manual. Additional notes about the use of the registers may be present in the driver structure (XXXDriver) and/or in the example applications.

Giovanni

[kisielk]

Hi,

The documentation only reports those fields that are architecture-independent. Those two fields are STM32-specific and, note, are register names, the documentation is the STM32 Reference Manual. Additional notes about the use of the registers may be present in the driver structure (XXXDriver) and/or in the example applications.

Giovanni

Thanks, that's as I suspected. So is the recommended thing to do is just read the header files? Or is there a way to use Doxygen to generate documentation locally that will include the STM32-specific bits? I only use STM32 processors at the moment so it would be valuable to have that documentation browsable.

[Giovanni]

Hi,

The files are usable with Doxygen, I plan to add doxyfiles in some later version.

Giovanni