[PATCH 7/8] timecounter: Add files to Doxygen group

Gedare Bloom gedare at rtems.org
Tue Jul 25 15:56:28 UTC 2023


Same thing here, these are imported files.

On Tue, Jul 25, 2023 at 2:49 AM Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
>
> Update #3707.
> ---
>  cpukit/include/machine/_timecounter.h | 2 ++
>  cpukit/include/sys/_ffcounter.h       | 9 +++++++++
>  cpukit/include/sys/timeffc.h          | 9 +++++++++
>  cpukit/include/sys/timepps.h          | 9 +++++++++
>  cpukit/include/sys/timetc.h           | 9 +++++++++
>  cpukit/include/sys/timex.h            | 9 +++++++++
>  6 files changed, 47 insertions(+)
>
> diff --git a/cpukit/include/machine/_timecounter.h b/cpukit/include/machine/_timecounter.h
> index 127e5f6fd3..e20e051f84 100644
> --- a/cpukit/include/machine/_timecounter.h
> +++ b/cpukit/include/machine/_timecounter.h
> @@ -3,6 +3,8 @@
>  /**
>   * @file
>   *
> + * @ingroup RTEMSScoreTimecounter
> + *
>   * @brief This header file provides timecounter definitions for the kernel space
>   *   (_KERNEL is defined before including <sys/time.h>) and RTEMS.
>   */
> diff --git a/cpukit/include/sys/_ffcounter.h b/cpukit/include/sys/_ffcounter.h
> index d83c48cd44..802c7d3224 100644
> --- a/cpukit/include/sys/_ffcounter.h
> +++ b/cpukit/include/sys/_ffcounter.h
> @@ -1,3 +1,12 @@
> +/**
> + * @file
> + *
> + * @ingroup RTEMSScoreTimecounter
> + *
> + * @brief This header file provides interfaces of the feed-forward clock
> + *   counter.
> + */
> +
>  /*-
>   * Copyright (c) 2011 The University of Melbourne
>   * All rights reserved.
> diff --git a/cpukit/include/sys/timeffc.h b/cpukit/include/sys/timeffc.h
> index c04de97f1d..13abd37a2b 100644
> --- a/cpukit/include/sys/timeffc.h
> +++ b/cpukit/include/sys/timeffc.h
> @@ -1,3 +1,12 @@
> +/**
> + * @file
> + *
> + * @ingroup RTEMSScoreTimecounter
> + *
> + * @brief This header file provides interfaces of the feed-back and
> + *   feed-forward clock implementations.
> + */
> +
>  /*-
>   * Copyright (c) 2011 The University of Melbourne
>   * All rights reserved.
> diff --git a/cpukit/include/sys/timepps.h b/cpukit/include/sys/timepps.h
> index 030c734477..502d93833e 100644
> --- a/cpukit/include/sys/timepps.h
> +++ b/cpukit/include/sys/timepps.h
> @@ -1,3 +1,12 @@
> +/**
> + * @file
> + *
> + * @ingroup RTEMSScoreTimecounter
> + *
> + * @brief This header file provides interfaces of the Pulse Per Second (PPS)
> + *   support.
> + */
> +
>  /*-
>   * ----------------------------------------------------------------------------
>   * "THE BEER-WARE LICENSE" (Revision 42):
> diff --git a/cpukit/include/sys/timetc.h b/cpukit/include/sys/timetc.h
> index 1ef58b378d..8f2537692c 100644
> --- a/cpukit/include/sys/timetc.h
> +++ b/cpukit/include/sys/timetc.h
> @@ -1,3 +1,12 @@
> +/**
> + * @file
> + *
> + * @ingroup RTEMSScoreTimecounter
> + *
> + * @brief This header file provides interfaces of the timecounter
> + *   implementation.
> + */
> +
>  /*-
>   * ----------------------------------------------------------------------------
>   * "THE BEER-WARE LICENSE" (Revision 42):
> diff --git a/cpukit/include/sys/timex.h b/cpukit/include/sys/timex.h
> index 8e763bb30f..36b1fcdb5a 100644
> --- a/cpukit/include/sys/timex.h
> +++ b/cpukit/include/sys/timex.h
> @@ -1,3 +1,12 @@
> +/**
> + * @file
> + *
> + * @ingroup RTEMSScoreTimecounter
> + *
> + * @brief This header file provides interfaces of the Network Time Protocol
> + *   (NTP) support.
> + */
> +
>  /*-
>   ***********************************************************************
>   *                                                                    *
> --
> 2.35.3
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel


More information about the devel mailing list