Documentation index entries for functions

[Chris Johns]

On 15/10/2022 12:58 am, Joel Sherrill wrote:
> On Fri, Oct 14, 2022 at 8:53 AM Sebastian Huber
> <sebastian.huber at embedded-brains.de <mailto:sebastian.huber at embedded-brains.de>>
> wrote:
>     On 14.10.22 15:45, Joel Sherrill wrote:
>     >
>     > While teaching an RTEMS class this week, I noticed that rtems_build_name
>     > is in the Classic API Guide index twice. Once with () and once without.
>     > I started to fix that one case when I noticed that it appears we are
>     > just very inconsistent.
>     >
>     > (rtemsdocs) [joel at localhost c-user]$ grep -r index::  | grep rtems_ |
>     > grep "()$" | wc -l
>     > 280
>     > (rtemsdocs) [joel at localhost c-user]$ grep -r index::  | grep rtems_ |
>     > grep -v "()$" | wc -l
>     > 158
>     >
>     > There are 280 index entries with () on a method name and 158 without.
> 
> FWIW Some of the 158 without could be rtems_ data types.  
> 
>     >
>     > Which way should it be? :)
> 
>     I strongly prefer the () style for functions and macros.
> 
> I should have mentioned that I also agree with this approach.  
> 
> If we get a third pro-parentheses vote, I'll make a sweep. 

+1

Chris