Doc updates - Githubissues

nRF24 / RF24Log

A nice logging library for Arduino devices

GNU General Public License v2.0

7 stars 4 forks source link

Doc updates #7

Closed 2bndy5 closed 3 years ago

2bndy5 commented 3 years ago

This removes all warnings in doxygen rendering. Also I fixed the indent in RF24AbstractHandler.h. @wmarkow I think your IDE is defaulting to use 3 or 6 spaces.

This should help visualize the hierarchy of class inheritence as doxygen provides some graphs.
Also worth noting that (using doxygen) docs are inherited like all other class members, so we only have to write them once 👍🏼

@wmarkow I'll be merging all commits (no squashing/fast-forwarding) until we have a suitable foundation (or I'm told otherwise) 😉

2bndy5 commented 3 years ago

Have I seen correctly that you commited somewhere the format for AStyle?

Yes. It was part of the wmarkow/RF24Log#1 in which I added the commonly used _/examples/examplesformatter.conf which can be utilized by AStyle with the cmd (from the /examples folder)

astyle --suffix=none --options=examples_formatter.conf --recursive ./*.ino,*.h,*.hpp,*.hh,*.hxx,*.h++,*.cpp,*.cc,*.cxx,*.c++,*.cp,*.c

wmarkow commented 3 years ago

@2bndy5, I think you can go ahead and merge the PR.