Syntax?
The problem with something simple...
// BOARD = Arduino Uno
...is that the developer may inadvertently create an action when they really meant to just document.
True. I was sort of thinking of
hidden directives in the *.ino file, or perhaps even board settings on a per sketch basis stored in or related to the recent sketches list. (I hadn't thought it out too in-depth.)
My Arduino simulator uses comments though, for simulator directives, and it works pretty well.
Would "extending" the Doxygen syntax be a good idea? Does anyone use Doxygen to document their projects?
I don't think that many people use Doxygen, especially not newcomers to Arduino.
If the ino includes any settings, should those settings track the actual IDE settings? If I change the board is the sketch automatically updated?
Yes, definitely. Although it was the title of this thread, it wouldn't necessarily need to be stored in the *.ino file, it just struck me that would be the most convenient.
Should the syntax include a tracking option?
Maybe, although that's not absolutely necessary, and might over-complicate things.
As you can tell, I didn't put a real lot of thought into this, but just felt it would be a nice feature, regardless of exactly how it was implemented.
