Possible bad comment on halconf.f

This forum is dedicated to feedback, discussions about ongoing or future developments, ideas and suggestions regarding the ChibiOS projects are welcome. This forum is NOT for support.
User avatar
tfAteba
Posts: 547
Joined: Fri Oct 16, 2015 11:03 pm
Location: Strasbourg, France
Has thanked: 91 times
Been thanked: 48 times

Possible bad comment on halconf.f

Postby tfAteba » Mon Jun 18, 2018 8:42 am

Hello Giovanni,

In all halconf.h files, I thinks that the file description is wrong.

We have now
@file templates/halconf.h

it should be header
@file halconf.h

or
@file ADC/halconf.h
for an ADC demo for example.

All file are impacted, I already updated the AVR files with the first proposal because I think it will be easy to modify all file in the future when there is no the demo name in the file description.

Are you Ok with that modification and do you allow me to make the same modification on all the project?

Thanks.
regards,

Theo.

User avatar
Giovanni
Site Admin
Posts: 14444
Joined: Wed May 27, 2009 8:48 am
Location: Salerno, Italy
Has thanked: 1074 times
Been thanked: 921 times
Contact:

Re: Possible bad comment on halconf.f

Postby Giovanni » Mon Jun 18, 2018 8:54 am

Hi,

The only halconf.h parsed by Doxygen is the one under templates, that path is intentional.

Giovanni

User avatar
tfAteba
Posts: 547
Joined: Fri Oct 16, 2015 11:03 pm
Location: Strasbourg, France
Has thanked: 91 times
Been thanked: 48 times

Re: Possible bad comment on halconf.f

Postby tfAteba » Mon Jun 18, 2018 9:18 am

Sorry but I don't understand :(
regards,

Theo.

User avatar
Giovanni
Site Admin
Posts: 14444
Joined: Wed May 27, 2009 8:48 am
Location: Salerno, Italy
Has thanked: 1074 times
Been thanked: 921 times
Contact:

Re: Possible bad comment on halconf.f

Postby Giovanni » Mon Jun 18, 2018 9:53 am

Hi,

That templates/ makes sure that I get an error from Doxygen if it picks up a different halconf.h for some reason.

Giovanni

User avatar
tfAteba
Posts: 547
Joined: Fri Oct 16, 2015 11:03 pm
Location: Strasbourg, France
Has thanked: 91 times
Been thanked: 48 times

Re: Possible bad comment on halconf.f

Postby tfAteba » Mon Jun 18, 2018 10:04 am

Hi,

Ok thanks for the explanation, so I will revert the commit made this morning.

Thanks
regards,

Theo.


Return to “Development and Feedback”

Who is online

Users browsing this forum: No registered users and 31 guests