BRegion: Style updates for documentation.

No functional changes intended.

* Updated copyright information.
* Reduced doxygen documentation down to a helpful summary
  in a regular comment, the documentation has been moved into
  the Haiku Book.
* Some parameter renaming for consistency and clarity.
* A few other style fixes.
This commit is contained in:
John Scipione
2014-06-03 20:26:45 -04:00
parent c1400fb617
commit 44cee34013
2 changed files with 87 additions and 181 deletions
+11 -9
View File
@@ -1,13 +1,14 @@
/*
* Copyright 2007, Haiku, Inc. All rights reserved.
* Copyright 2003-2014 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*/
#ifndef _REGION_H
#define _REGION_H
#include <Rect.h>
namespace BPrivate {
class ServerLink;
class LinkReceiver;
@@ -26,11 +27,11 @@ typedef struct {
class BRegion {
public:
BRegion();
BRegion(const BRegion& region);
BRegion(const BRegion& other);
BRegion(const BRect rect);
virtual ~BRegion();
BRegion& operator=(const BRegion& from);
BRegion& operator=(const BRegion& other);
bool operator==(const BRegion& other) const;
void Set(BRect newBounds);
@@ -48,7 +49,7 @@ public:
int32 CountRects() const;
bool Intersects(BRect rect) const;
bool Intersects(clipping_rect rect) const;
bool Intersects(clipping_rect clipping) const;
bool Contains(BPoint point) const;
bool Contains(int32 x, int32 y);
@@ -62,11 +63,11 @@ public:
void MakeEmpty();
void Include(BRect rect);
void Include(clipping_rect rect);
void Include(clipping_rect clipping);
void Include(const BRegion* region);
void Exclude(BRect r);
void Exclude(clipping_rect r);
void Exclude(BRect rect);
void Exclude(clipping_rect clipping);
void Exclude(const BRegion* region);
void IntersectWith(const BRegion* region);
@@ -82,7 +83,7 @@ private:
friend class Support;
private:
BRegion(const clipping_rect& rect);
BRegion(const clipping_rect& other);
void _AdoptRegionData(BRegion& region);
bool _SetSize(int32 newSize);
@@ -99,4 +100,5 @@ private:
clipping_rect* fData;
};
#endif // _REGION_H