@@ -50,7 +50,7 @@ Even pure cosmetics can have a significant impact on how easily code can be read
5050In the POV-Ray project, we are using the following formatting style for new code, and are in the process of
5151transitioning existing code to these coventions:
5252
53- - Indentation follows Allman style, with an indent of 4 spaces (no tabs), e.g.:
53+ - Indentation of braces follows Allman style, with an indent of 4 spaces (no tabs), e.g.:
5454
5555 while (x == y)
5656 {
@@ -233,6 +233,8 @@ source code with comments.
233233The interface provided by any source file should be documented in the respective header file, using
234234a format compatible with Doxygen 1.8.8. For consistency, please use JavaDoc-style comments (` /// ... `
235235or ` /** ... */ ` ; the general rules for comments apply) and JavaDoc-style tags (` @``foo ` ).
236+ C++ single-line style comments should be preferred, as block comments may occasionally interfere with
237+ Doxygen's Markdown support.
236238
237239@note Platform-specific modules may mandate a different tag style, such as (hypothetically) DocXML
238240 style for the Windows GUI modules.
@@ -254,6 +256,8 @@ following guidelines:
254256 - ** Attention** : Use the ` @``attention ` tag when documenting pitfalls that may come as a big surprise to the reader or
255257 have grave effects when not avoided.
256258
259+ However, always use the following instead if they are appropriate:
260+
257261 - ** To-Do** : Use the ` @``todo ` tag when documenting that something is still unfinished and needs more work.
258262 - ** Deprecated** : Use the ` @``deprecated ` tag when documenting that somehting is only kept around for backward
259263 compatibility and should no longer be used in new code.
0 commit comments