• State
  • Locked Locked
  • Replies 3 replies
  • Subscribers 78 subscribers
  • Views 1119 views
  • Users 0 members are here
Support feedback
Options
Options
Similar topics

This thread has been locked.

If you have a related question, please click the "Ask a related question" button in the top right corner. The newly created question will be automatically linked to this question.

Another Grace suggestion: automated code documentation

Michael Wirth
Intellectual 955 points

With Grace generating the initialization code for the peripherals, there's no good place to put the associated documentation anymore.  It does do a good job of documenting the various register bit fields, e.g., I especially appreciate the use of ~BLAP comments to indicate that the BLAP field is not set, as opposed to the mnemonic just being omitted from the setter.

But that doesn't allow me to indicate why I'm using a particular setting in the context of my application, e.g., "Set count-up mode until the first interrupt on the test line, P1.3, indicates that the fribit device is ready."

Here's what I'd like to see in Grace, in order of suspected effort on your part:

1. Add a text box at the bottom of the input panels for user comments.  Use this text to generate an additional block comment in the generated code, at the appropriate place.

2. Add text boxes for each field, e.g., the mode selector for Timer A, Channel 0.  This can probably generate //-style comments.

3. Put both your and user-generated comments in parsable "Doxygen" (or similar tool) format so a post-processor (part of the Grace Eclipse plugin?) can generate automated, nicely formatted documentation on the project's initialization code.

Mike (appreciating Grace and wishing for more)

  • 0
    TI__Mastermind 18320 points

    Mike,

    Thanks for your suggestions -- they are much appreciated.  We have been having discussions for a while about adding user-modifiable sections to the generated source code, and I have added your comments to the enhancement request to make sure we at least take your input into account.

    Dave

  • 0 in reply to David Friedland
    Intellectual 955 points

    Dave, and the rest of the Grace team,

    Thanks for the feedback that my messages are getting read :-)

    While I'm at it (have a lot more suggestions; I should write them up for you).  Here are a couple:

    * An interrupt overview page would be great -- have to do that on paper now.

    * When I enable a device, e.g., USCI_A0, and set an ISR for it, I should have an option to leave it disabled.  Right now I have to disable it by hand after the Grace code runs and before enabling global interrupts, so that I can carefully control the order that my event-handling gets set up.

    * This isn't grace, but the debugger in CCS -- it would also be nice to have a compact view of all the interrupt settings (IFGs and IEs, etc.) in the watch window.  (Is that possible now and I've just missed it?)

    Mike

  • 0 in reply to Michael Wirth
    TI__Mastermind 18320 points

    Thanks Mike. 

    I think we have the first item grocked.

    For the third item, if you have any specific feedback on CCS, please go ahead and post that separately in the CCS forum.  In particular, the guys there would be interested in seeing feedback on CCS 5.1.

    For the second item, that looks like a good idea to be and I filed it as an enhancement request (Bug 2538 - Grace should let users disable an ISR from running).

    Dave

**Attention** This is a public forum