Skip to content

Commit

Permalink
BRegion: Style updates for documentation.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jscipione committed Jun 4, 2014
1 parent c1400fb commit 44cee34
Show file tree
Hide file tree
Showing 2 changed files with 87 additions and 181 deletions.
20 changes: 11 additions & 9 deletions headers/os/interface/Region.h
@@ -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;
Expand All @@ -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);
Expand All @@ -48,7 +49,7 @@ class BRegion {
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);
Expand All @@ -62,11 +63,11 @@ class BRegion {
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);
Expand All @@ -82,7 +83,7 @@ class BRegion {
friend class Support;

private:
BRegion(const clipping_rect& rect);
BRegion(const clipping_rect& other);

void _AdoptRegionData(BRegion& region);
bool _SetSize(int32 newSize);
Expand All @@ -99,4 +100,5 @@ class BRegion {
clipping_rect* fData;
};


#endif // _REGION_H

0 comments on commit 44cee34

Please sign in to comment.