Skip to content

Commit 39a6c9f

Browse files
committed
[ci skip] Minor changes to comments and dev documentation.
1 parent edfae26 commit 39a6c9f

File tree

6 files changed

+15
-7
lines changed

6 files changed

+15
-7
lines changed

source-doc/compiler.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Compiler Requirements {#compiler}
22

33

4-
@section exot General Presumptions
4+
General Presumptions {#compiler_exot}
5+
====================
56

67
While POV-Ray is being developed with portability high in mind, the C++ standard allows for some degrees of freedom that
78
we consider too exotic to cater to. We therefore presume all compilers and runtime environments to adhere to the
@@ -18,10 +19,11 @@ following additional restrictions:
1819
separator, in include directives.
1920

2021
- **Integer Division**: Integer division is presumed to round towards zero. This also implies that the remainder (as
21-
computed by the modulus operator '%') is negative (or zero) if the dividend and divisor have different sign.
22+
computed by the modulus operator `%`) is negative (or zero) if the dividend and divisor have different sign.
2223

2324

24-
@section povms POVMS Additional Restrictions
25+
POVMS Additional Restrictions {#compiler_povms}
26+
=============================
2527

2628
To support network rendering (a feature not yet implemented but planned) in a heterogenous network, the POVMS interface
2729
imposes the following additional restriction on the compiler:

source-doc/styleguide.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Even pure cosmetics can have a significant impact on how easily code can be read
5050
In the POV-Ray project, we are using the following formatting style for new code, and are in the process of
5151
transitioning 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.
233233
The interface provided by any source file should be documented in the respective header file, using
234234
a format compatible with Doxygen 1.8.8. For consistency, please use JavaDoc-style comments (`/// ...`
235235
or `/** ... */`; 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.

source/base/version.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
#define OFFICIAL_VERSION_STRING "3.7.1"
4646
#define OFFICIAL_VERSION_NUMBER 371
4747

48-
#define POV_RAY_PRERELEASE "alpha.8698543"
48+
#define POV_RAY_PRERELEASE "alpha.8701451"
4949

5050
#if (POV_RAY_IS_AUTOBUILD == 1) && ((POV_RAY_IS_OFFICIAL == 1) || (POV_RAY_IS_SEMI_OFFICIAL == 1))
5151
#ifdef POV_RAY_PRERELEASE

source/core/configcore.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ namespace pov
6666
#endif
6767

6868
#ifndef LIGHT_INTERSECTION_VECTOR_SIZE
69-
#define LIGHT_INTERSECTION_VECTOR_SIZE 512
69+
#define LIGHT_INTERSECTION_VECTOR_SIZE 512 // TODO - I think this should be LIGHTSOURCE_VECTOR_SIZE*2 [CLi]
7070
#endif
7171

7272
#ifndef LIGHTSOURCE_VECTOR_SIZE

source/parser/parser.cpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3315,6 +3315,7 @@ ObjectPtr Parser::Parse_Light_Source ()
33153315
Parse_Begin();
33163316
EXPECT
33173317
#ifdef GLOBAL_PHOTONS
3318+
// TODO -- if we ever revive this, we need to choose a different keyword for this
33183319
CASE(GLOBAL_TOKEN)
33193320
Object->Ph_Density = Allow_Float(1.0);
33203321
if (Object->Ph_Density > 0)
@@ -7136,6 +7137,7 @@ void Parser::Parse_Global_Settings()
71367137
END_CASE
71377138

71387139
#ifdef GLOBAL_PHOTONS
7140+
// TODO -- if we ever revive this, we need to choose a different keyword for this
71397141
CASE(GLOBAL_TOKEN)
71407142
sceneData->photonSettings.globalCount = (int)Parse_Float();
71417143
END_CASE

unix/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.7.1-alpha.8698543
1+
3.7.1-alpha.8701451

0 commit comments

Comments
 (0)