Skip to content

Commit 7942c1b

Browse files
committed
Add some doc.
1 parent b08fc34 commit 7942c1b

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

alg/viewshed/viewshed_types.h

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ struct Options
8484
int observerSpacing{10}; //!< Observer spacing in cumulative mode.
8585
uint8_t numJobs{3}; //!< Relative number of jobs in cumulative mode.
8686

87+
/// True if angle masking will occur.
8788
bool angleMasking() const
8889
{
8990
return startAngle != endAngle;
@@ -100,6 +101,7 @@ struct Window
100101
int yStart{}; //!< Y start position
101102
int yStop{}; //!< Y end position
102103

104+
/// Returns true when one window is equal to the other.
103105
bool operator==(const Window &w2) const
104106
{
105107
return xStart == w2.xStart && xStop == w2.xStop &&
@@ -181,9 +183,9 @@ inline std::ostream &operator<<(std::ostream &out, const Window &w)
181183
return out;
182184
}
183185

184-
// Processing limits based on min/max distance restrictions.
185-
// The left side processing range is [left, leftMin).
186-
// The right side processing range is [rightMin, right).
186+
/// Processing limits based on min/max distance restrictions.
187+
/// The left side processing range is [left, leftMin).
188+
/// The right side processing range is [rightMin, right).
187189
struct LineLimits
188190
{
189191
LineLimits(int leftArg, int leftMinArg, int rightMinArg, int rightArg)

0 commit comments

Comments
 (0)