Quality RTOS & Embedded Software

 Real time embedded FreeRTOS RSS feed 
Quick Start Supported MCUs PDF Books Trace Tools Ecosystem TCP & FAT




Loading

doxygen warnings in semphr.h

Posted by Maxim on March 26, 2008
Hi Richard,

if I run doxygen over my project (includes FreeRTOS v4.7.2) I get the following warnings from semphr.h:
.../semphr.h:105: Warning: found </pre> tag without matching <pre>
.../semphr.h:467: Warning: explicit link request to 'define' could not be resolved
.../semphr.h:468: Warning: explicit link request to 'define' could not be resolved

Line 105: I suppose <pre> is missing
Line 467, 468: maybe it would be better to use \example or \code for API examples. \pre actually means "precondition":

http://www.stack.nl/~dimitri/doxygen/commands.html

Regards
Maxim

RE: doxygen warnings in semphr.h

Posted by Richard on March 26, 2008
Originally Doxygen was used for everything, including generating the HTML for the FreeRTOS.org WEB site - however this was some time ago and the Doxygen compatibility has not been maintained for many years - I'm surprised you get anything sensible out of it.

In this case the <pre> is an HTML tag, not a doxygen tag, for PREformatted. I think the problem is there is no doxygen tag before it to tell doxygen to ignore it.

Regards.


[ Back to the top ]    [ About FreeRTOS ]    [ Sitemap ]    [ ]




Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.

Latest News

FreeRTOS kernel V10 is available for immediate download. Now MIT licensed.


FreeRTOS Partners

ARM Connected RTOS partner for all ARM microcontroller cores

IAR Partner

Microchip Premier RTOS Partner

RTOS partner of NXP for all NXP ARM microcontrollers

STMicro RTOS partner supporting ARM7, ARM Cortex-M3, ARM Cortex-M4 and ARM Cortex-M0

Texas Instruments MCU Developer Network RTOS partner for ARM and MSP430 microcontrollers

OpenRTOS and SafeRTOS