Documentation index entries for functions

[Sebastian Huber]

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.
> 
> Which way should it be? :)

I strongly prefer the () style for functions and macros.

-- 
embedded brains GmbH
Herr Sebastian HUBER
Dornierstr. 4
82178 Puchheim
Germany
email: sebastian.huber at embedded-brains.de
phone: +49-89-18 94 741 - 16
fax:   +49-89-18 94 741 - 08

Registergericht: Amtsgericht München
Registernummer: HRB 157899
Vertretungsberechtigte Geschäftsführer: Peter Rasmussen, Thomas Dörfler
Unsere Datenschutzerklärung finden Sie hier:
https://embedded-brains.de/datenschutzerklaerung/