• State Not Answered
  • Locked Locked
  • Replies 2 replies
  • Subscribers 21 subscribers
  • Views 1489 views
  • Users 0 members are here
Options
Related
How was your experience today?
This discussion has been locked.
You can no longer post new replies to this discussion. If you have a question you can start a new discussion

uVision: Documentation for Functions

Nicholas_

Good day, everyone!

I had tried to do some searching on this functionality, but I might had used the incorrect words to describe that feature.  So I do apologize if this had been asked mutliple times already.  I am trying to find out how I can use the documentation for user made functions.  When viewing the functions that were provided by uVision, for example the CAN_LPC18xx.c, there are functions that contain:

  • \fn - Function Name
  • \brief - Short description of the function
  • \param[in] - Argument description
  • \return - return description

/**
  \fn          uint32_t CANx_WaitWhileBusy (uint8_t x)
  \brief       Wait for CMDREQ_BUSY flag to clear
  \param[in]   x      Controller number (0..1)
  \return      1 = OK; 0 = timeout
*/
static __INLINE uint32_t CANx_WaitWhileBusy (uint8_t x) {...}

Is there a way that I can have the template automatically generate for me in uVision, is there any formal documentation as to how I can use that feature?  I am aware, for example, in C# using Visual Studio I can use three consecutive backlashes to have a template almost adjacent above.

Thank you for your time!

Parents
  • 0 in reply to Grant B

    I had installed the binary and followed the instructions during the setup phase.  While it creates documentation using HTML pages, which is cool - but it does not change the source such that it provides:

    /**
  \fn          void GPIO_PortClock (uint32_t clock)
  \brief       Port Clock Control
  \param[in]   clock  Enable or disable clock
*/
void GPIO_PortClock (uint32_t clock) {...}

    So, to elaborate a bit, every time I create a new function such as:

    void ExampleFunction (uint32_t Num0, float Num1, char* cString) {...}

    I would like Kiel's uVision to automatically provide me with:

    /**
  \fn          void ExampleFunction (uint32_t Num0,
                                 float Num1,
                                 char* cString)
  \brief
  \param[in]   Num0
  \param[in]   Num1
  \param[in]   cString
*/

    Of course I would have to provide information in 'brief' and the parameters for this example.

    If incase I am not using Doxygen correctly, please let me know.  I now have a shortcut in my Tools menu for 'Make Template' and 'Generate Documentation', but it seems that the documentation that it generates - is not entirely what I am looking for as it merely creates HTML pages.

Reply
  • 0 in reply to Grant B

    I had installed the binary and followed the instructions during the setup phase.  While it creates documentation using HTML pages, which is cool - but it does not change the source such that it provides:

    /**
  \fn          void GPIO_PortClock (uint32_t clock)
  \brief       Port Clock Control
  \param[in]   clock  Enable or disable clock
*/
void GPIO_PortClock (uint32_t clock) {...}

    So, to elaborate a bit, every time I create a new function such as:

    void ExampleFunction (uint32_t Num0, float Num1, char* cString) {...}

    I would like Kiel's uVision to automatically provide me with:

    /**
  \fn          void ExampleFunction (uint32_t Num0,
                                 float Num1,
                                 char* cString)
  \brief
  \param[in]   Num0
  \param[in]   Num1
  \param[in]   cString
*/

    Of course I would have to provide information in 'brief' and the parameters for this example.

    If incase I am not using Doxygen correctly, please let me know.  I now have a shortcut in my Tools menu for 'Make Template' and 'Generate Documentation', but it seems that the documentation that it generates - is not entirely what I am looking for as it merely creates HTML pages.

Children
No data