Quality RTOS & Embedded Software

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




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) 2004-2010 Richard Barry. Copyright (C) 2010-2016 Real Time Engineers Ltd.
Any and all data, files, source code, html content and documentation included in the FreeRTOSTM distribution or available on this site are the exclusive property of Real Time Engineers Ltd.. See the files license.txt (included in the distribution) and this copyright notice for more information. FreeRTOSTM and FreeRTOS.orgTM are trade marks of Real Time Engineers Ltd.

Latest News:

FreeRTOS V9.0.0 is now available for download.


Free TCP/IP and file system demos for the RTOS


Sponsored Links

⇓ Now With No Code Size Limit! ⇓
⇑ Free Download Without Registering ⇑


FreeRTOS Partners

ARM Connected RTOS partner for all ARM microcontroller cores

Renesas Electronics Gold Alliance RTOS Partner.jpg

Microchip Premier RTOS Partner

RTOS partner of NXP for all NXP ARM microcontrollers

Atmel RTOS partner supporting ARM Cortex-M3 and AVR32 microcontrollers

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

Xilinx Microblaze and Zynq partner

Silicon Labs low power RTOS partner

Altera RTOS partner for Nios II and Cortex-A9 SoC

Freescale Alliance RTOS Member supporting ARM and ColdFire microcontrollers

Infineon ARM Cortex-M microcontrollers

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

Cypress RTOS partner supporting ARM Cortex-M3

Fujitsu RTOS partner supporting ARM Cortex-M3 and FM3

Microsemi (previously Actel) RTOS partner supporting ARM Cortex-M3

Atollic Partner

IAR Partner

Keil ARM Partner

Embedded Artists