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.

CCS/TM4C123BH6ZRB: CCS 6.1.1.00022 function/variable description hover pop-up

Part Number: TM4C123BH6ZRB

Tool/software: Code Composer Studio

We are formalizing our coding style specification.  We now have a dozen projects using CCS.

We are discussing how to describe a function or a data element.

Description = function header = what pops up when you hover the cursor over a function/data reference = text preceding the declaration or definition.

I have just been playing around with this and I have found that:

  • When the function is defined and declared in a library, and you are not working in that library's project, you get the comments and declaration in the header file.
  • When the function is defined and declared in the project you are working in, then you get the entire function definition and function comment header from the .c file.

We would like the popup information to come from the header file, as that is what is public.  We do not want an application developer digging around in a library function for its description.

Can we get the popup information to always display the function header found above the declaration?

So if the declaration is in a header file, then that is what you get.

If it is a local function to a .c file, you would get the function header found above the declaration in the .c file.

We are trying to steer clear of having a function description in two places, as it increases the chance that at least one description is stale.

What are the rules on this CCS hover popup feature?

What is the feature called?