Results (1 - 10 of 10)
- TBR/Website/FAQ: = FAQ = [[TOC(TBR/Website/FAQ, depth=2)]] * ...
- ... DateTimeIssues Date/Time issues] in RTEMS? * [wiki:Developer/Coding/GenerateAPatch How do I make a patch]? * [wiki:ApplyAPatch How do I apply a patch]? * [wiki:WhyLargeExecutable Why is my executable so large?] * Can I [wiki:TBR/UserManual/Using_C_Plus_Plus use C++]? * What is [wik ...
- By Ayushman Mishra — 02/21/21 16:29:16
- Developer/Coding/Doxygen: = Doxygen Recommendations = = Doxygen Best Practices = * Do ...
- = Doxygen Recommendations = = Doxygen Best Practices = * Do not use ''@a''. Instead use ''@param'' to document function parameters. * Do not use ''@return''. Instead use ''@retval'' to document return status codes. * Do no ...
- By Joel Sherrill — 04/30/20 22:19:09
- Developer/Coding/Doxygen_for_BSPs: = Doxygen Recommendations for BSPs = RTEMS contains well over a ...
- ... In addition to this, check out the page on [wiki:Developer/Coding/Doxygen Doxygen Recommendations], which also contains a fair amount of information that will not be covered here. = Doxygen Basics = Doxygen is a documentation generator. It allows for documentation to be written rig ...
- By Joel Sherrill — 10/23/18 18:16:24
- GCI/Documentation/DoxygenFileHeaders: = PAGE_TITLE = [[TOC(PAGE_LOCATION, depth=2)]] == Task ...
- ... you should also read through [wiki:Developer/Coding/Doxygen Doxygen Recommendations]. === Add Doxygen File Headers === The RTEMS source base has been in a long process to use Doxygen. But since Doxygen is newer than RTEMS, there are still lots of files which don't have ...
- By Gedare Bloom — 09/12/18 19:36:47
- Developer/Coding/Boilerplate_File_Header: = Boilerplate File Header = Every file should include two ...
- = Boilerplate File Header = Every file should include two comment header blocks, one for the Doxygen output and a copyright notice. This is a typical example: {{{ /** * @file * * @ingroup TheGroupForThisFile * * @brief ...
- By Malte Münch — 05/18/18 20:09:21
- Developer/Coding/ThirdPartyCode: = Contributing 3rd Party Code = ...
- = Contributing 3rd Party Code = [[TOC(Developer/Coding/ThirdPartyCode , depth=2)]] You should retain the original code's licensing and copyright information. Be careful with copyright and code ownership, these things matter. The best approach is to provide an isolated p ...
- By Gedare Bloom — 04/09/16 21:04:34
- Developer/Coding/Deprecating: = Deprecating Public Application Programming Interfaces = ...
- ... [[TOC(Developer/Coding/Deprecating, depth=2)]] This page documents the procedures for deprecating a public-facing interface in RTEMS. == Use the deprecate attribute == Add the RTEMS_COMPILER_DEPRECATED_ATTRIBUTE, which for gcc wraps the ...
- By Ralph Holmes — 01/06/16 15:42:40
- Developer/Coding/GenerateAPatch: = Generate A Patch = The RTEMS patches to the development tools ...
- = Generate A Patch = The RTEMS patches to the development tools are generated using a command like this {{{ diff -N -P -r -c TOOL-original-image TOOL-with-changes >PATCHFILE }}} where the options are: * -N and -P take car ...
- By Chris Johns — 03/15/15 06:51:50
- Developer/Coding/NamingRules: = Naming rules = = General rules = * Avoid abbreviations. * ...
- = Naming rules = = General rules = * Avoid abbreviations. * Exception: when the abbreviation is more common than the full word. * Exception: For well-known acronyms. * Use descriptive language. * File names should be ...
- By Chris Johns — 11/22/14 04:53:11
- Developer/Coding/Compile-time_feature-conditioned_compilation: = Compile-time feature-conditioned compilation = = Compile-Time ...
- = Compile-time feature-conditioned compilation = = Compile-Time Conditional Code Features = Some RTEMS features are compile-time dependent and normally can be enabled/disabled via RTEMS build configuration options, for example --enable-s ...
- By Gedare — 05/30/14 17:25:57
Note: See TracSearch
for help on searching.