[driver] RTC MCP7941X

[odinthenerd]

somewhere in the initialization I messed something up, I think I need a second pair of eyes

[rleh]

CI is failing because you have to update the documentation by running the script

$ python3 tools/scripts/synchronize_docs.py

and remove trailing whitespaces.

[odinthenerd]

jo #fail, thanks

[rleh]

Please also include an example for one of the existing development boards.

[odinthenerd]

ok I'll make a black pill board example

[rleh]

Works on real hardware ✅

[chris-durand]

Thanks!

[rleh]

Ups.

[chris-durand]

@rleh What is the issue? Just the formatting or anything else I am to blind to see right now?

[salkinium]

The datasheet link should go into the module.lb instead of the license header. This particular formatting makes it look like it's part of the license as well.

[salkinium]

Unrelated, the struct mcp7941x should also have a /// @ingroup modm_driver_mcp7941x on top of it, otherwise doxypress will not group it correctly (sadly).

[rleh]

Line 10 does not belong in the license header. I probably copy-pasted it in there by mistake.

[chris-durand]

Of course, I was blind ... Will fix it as well.

[salkinium]

Running doxypress on the example causes a segfault too:

Initialization
Parse input files
Error: Possible recursive class relation while inside modm::mcp7941x and looking for derived class I2cDevice< I2cMaster, 2 >

**  Generate Documentation Output
Error: Possible recursive class relation while inside modm::mcp7941x and looking for base class modm::mcp7941x::DateTime
Error: Possible recursive class relation while inside I2cDevice< I2cMaster, 2 > and looking for base class modm::mcp7941x::DateTime
Error: Possible recursive class relation while inside NestedResumable< 10+1 > and looking for base class modm::mcp7941x::DateTime
Warning: class modm::mcp7941x seem to have a recursive inheritance relation!

[salkinium]

recursive inheritance relation?

I tried a couple of things, nothing fixes this?

[chris-durand]

This is the line in doxypress where it triggers the message: https://github.com/copperspice/doxypress/blob/1e286c033d4ab8499e42de9016e4f196f66f5f0f/src/classdef.cpp#L2535

It's a doxypress bug. Change the class to

template < class I2cMaster >
class Mcp7941x :  public mcp7941x,

and it appears to work for me. @salkinium Could you try if it works for you? I'll make a PR to fix it if it works.

[salkinium]

Yes, that works for me both in the example and in the docs generator!

[rleh]

I can confirm the your fix solves the issue!

template < class I2cMaster >
-class Mcp7941x :       public modm::mcp7941x,
+class Mcp7941x :       public mcp7941x,
					public modm::I2cDevice<I2cMaster, 2>

[chris-durand]

Ok, I'll make a PR now and later try to fix the bug in doxypress.