Re: README.md files per directory

Hi,

I would add the file to the INPUT variable in Doxyfile-net80211. The file 
can be named however you want, it just needs to contain doxygen syntax.
Once you have rewiewed the docs and are OK with it, I suggest to remove the 
$(NOTREVIEWED), which points to not reviewed.dox in the same directory. 
This serves also as an example of how you can add any file.

Regarding the other email about AI: I agree that blindly adding AI 
generated docs may lead to incorrect docs, which would be counter productive.

Letting AI help generating docs and reviewing it on the other hand may safe 
time and effort. Someone doing this should pay attention to not want to 
spend too much time in interactive use of AI and to have a good threshold 
between using AI assistance and switching to write / improve parts via 
natural intelligence...

I also see a benefit in using AI for non-native English speakers (good 
English writing style) and readers (easy to understand / translate).

Bye,
Alexander.

-- 
Send from a mobile device, please forgive brevity and misspellings.
Am 20. April 2026 02:20:43 schrieb Adrian Chadd <[email protected]>:

> On Sun, 19 Apr 2026 at 05:46, Alexander Leidinger
> <[email protected]> wrote:
>
>>
>> The /usr/src/tools/kerneldoc/subsys/ parts are taking source and header
>> files into account. See FILE_PATTERNS in
>> /usr/src/tools/kerneldoc/subsys/common-Doxyfile. Additionally you can
>> specify any additional file to include in the config, see INPUT in
>> /usr/src/tools/kerneldoc/subsys/Doxyfile-*.
>
> Ok, thanks, I've built the net80211 ones locally and I'll see how it looks.
>
> How about the top level subsystem documentation and function call documentation
> rather than API documentation? Is there any way to say, insert some
> documentation
> that's in the source tree somewhere into the subsystem? eg for
> net80211, can I add
> subsystem documentation somewhere that doxygen would pull in and be able to 
> use?
> If so where would I put that?
>
> Thanks!
>
>
> -a