highperfocused/tenacity
1
0
Fork 0
mirror of https://codeberg.org/tenacityteam/tenacity synced 2025-09-27 16:56:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen: Remove obsolete sections

Browse Source 
- Remove obsolete section on #pragma once
- Add obsoletion warning to cross platform coding tips page.

Signed-off-by: Avery King <avery98@pm.me>
This commit is contained in:
Avery King
2023-07-05 13:49:36 -07:00
parent 80b7f2f3d7
commit f4f06a4859
1 changed files with 4 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
dox2-src/CrossPlatform.dox2
View File

@@ -18,29 +18,13 @@ that we can get the comments to show correctly in the output files.
\page CrossPlatform Cross Platform Coding Tips \page CrossPlatform Cross Platform Coding Tips
\brief Guidelines for making the code compile and work on all supported platforms. \brief Guidelines for making the code compile and work on all supported platforms.
\section PragmaOnce \#pragma once \warning This page likely contains obsolete material. Some material may no
longer apply to modern compilers. This page will likely be removed in the
The following is not supported under gcc 2.x: future.
\code
// WRONG
#pragma once
\endcode
Instead use the traditional:
\code
#ifndef __AUDACITY_HEADER_FILE_NAME__
#define __AUDACITY_HEADER_FILE_NAME__
// your header file contents goes here.
#endif
\endcode
\section UnicodeStrings Unicode strings \section UnicodeStrings Unicode strings
Audacity code is translated, and it may be built in Unicode versions. Tenacity code is translated, and it may be built in Unicode versions.
For this reason all strings should be wrapped like this: For this reason all strings should be wrapped like this:
\code \code