Authored by Hal Mueller

Added Doxygen tags to some existing comments. Added some RMLog(NSLog) statements…

… to memory warning handlers. Made Doxygen target open completed doc tree after build.
... ... @@ -111,6 +111,7 @@
-(void) didReceiveMemoryWarning
{
LogMethod();
}
-(NSString *)uniqueTilecacheKey
... ...
... ... @@ -41,7 +41,7 @@
- (id) initWithSource: (id<RMTileSource>) source;
- (void) didReceiveMemoryWarning;
// Bleah ugly name.
/// Bleah ugly name.
+ (RMCachedTileSource*) cachedTileSourceWithSource: (id<RMTileSource>) source;
- (id<RMTileSource>) underlyingTileSource;
... ...
... ... @@ -105,6 +105,7 @@
- (void) didReceiveMemoryWarning
{
LogMethod();
[cache didReceiveMemoryWarning];
}
... ...
... ... @@ -163,6 +163,7 @@
-(void)didReceiveMemoryWarning
{
LogMethod();
if (self.databasePath==nil) {
RMLog(@"unknown db path, unable to reinitialize dao!");
return;
... ...
... ... @@ -31,13 +31,13 @@
@class RMProjection;
@interface RMFractalTileProjection : NSObject<RMMercatorToTileProjection> {
// Maximum zoom for which our tile server stores images
/// Maximum zoom for which our tile server stores images
int maxZoom;
// Mercator bounds of the earth
/// Mercator bounds of the earth
RMXYRect bounds;
// Normally 256. This class assumes tiles are square.
/// Normally 256. This class assumes tiles are square.
int tileSideLength;
// The deal is, we have a scale which stores how many mercator gradiants per pixel
... ...
... ... @@ -32,6 +32,10 @@
#if TARGET_OS_IPHONE
#import <CoreLocation/CoreLocation.h>
/*! \struct RMLatLongBounds
Specifies a region by northwest and southeast corners.
Note: northWest and southEast will change to northeast and southwest (note spelling and corner changes) after 0.5 to keep right-handed coordinate system
*/
typedef struct {
CLLocationCoordinate2D northWest;
CLLocationCoordinate2D southEast;
... ...
... ... @@ -73,14 +73,14 @@ enum {
{
// TODO: Also support NSView.
// This is the underlying UIView's layer.
/// This is the underlying UIView's layer.
CALayer *layer;
RMMarkerManager *markerManager;
RMMapLayer *background;
RMLayerSet *overlay;
// Latlong is calculated dynamically from mercatorBounds.
/// Latlong is calculated dynamically from mercatorBounds.
RMProjection *projection;
id<RMMercatorToTileProjection> mercatorToTileProjection;
... ...
... ... @@ -271,6 +271,7 @@
- (void) didReceiveMemoryWarning
{
LogMethod();
[tileSource didReceiveMemoryWarning];
}
... ...
... ... @@ -135,8 +135,8 @@ typedef struct {
BOOL _contentsIsSet; // "contents" must be set, but is initialized lazily to allow apps to override defaults in -awakeFromNib
}
// Any other functionality you need to manipulate the map you can access through this
// property. The RMMapContents class holds the actual map bits.
/// Any other functionality you need to manipulate the map you can access through this
/// property. The RMMapContents class holds the actual map bits.
@property (nonatomic, retain) RMMapContents *contents;
@property (nonatomic, retain, readonly) RMMarkerManager *markerManager;
... ...
... ... @@ -547,7 +547,8 @@
// Must be called by higher didReceiveMemoryWarning
- (void)didReceiveMemoryWarning
{
[contents didReceiveMemoryWarning];
LogMethod();
[contents didReceiveMemoryWarning];
}
- (void)setFrame:(CGRect)frame
... ...
... ... @@ -66,6 +66,7 @@
-(void) didReceiveMemoryWarning
{
LogMethod();
[cache removeAllObjects];
}
... ...
... ... @@ -39,7 +39,7 @@ typedef enum {
@protocol RMTileCache<NSObject>
// Returns the cached image if it exists. nil otherwise.
/// Returns the cached image if it exists. nil otherwise.
-(RMTileImage*) cachedImage:(RMTile)tile;
-(void)didReceiveMemoryWarning;
... ... @@ -59,10 +59,10 @@ typedef enum {
+(NSNumber*) tileHash: (RMTile)tile;
// Add tile to cache
/// Add tile to cache
-(void)addTile: (RMTile)tile WithImage: (RMTileImage*)image;
// Add another cache to the chain
/// Add another cache to the chain
-(void)addCache: (id<RMTileCache>)cache;
-(void)didReceiveMemoryWarning;
... ...
... ... @@ -133,6 +133,7 @@
-(void)didReceiveMemoryWarning
{
LogMethod();
for (id<RMTileCache> cache in caches)
{
[cache didReceiveMemoryWarning];
... ...
... ... @@ -56,8 +56,7 @@
-(void) addTile: (RMTile) tile WithImage: (RMTileImage *)image At: (CGRect) screenLocation;
-(void) addTile: (RMTile) tile At: (CGRect) screenLocation;
// Add tiles inside rect protected to bounds. Return rectangle containing bounds
// extended to full tile loading area
/// Add tiles inside rect protected to bounds. Return rectangle containing bounds extended to full tile loading area
-(CGRect) addTiles: (RMTileRect)rect ToDisplayIn:(CGRect)bounds;
-(RMTileImage*) imageWithTile: (RMTile) tile;
... ...
... ... @@ -42,9 +42,12 @@
// Size in pixels
// CGSize viewSize;
// Scale is how many meters in 1 pixel. Larger scale means bigger things are smaller on the screen.
// Scale of 1 means 1 pixel == 1 meter.
// Scale of 10 means 1 pixel == 10 meters.
/*! \brief "scale" as of version 0.4/0.5 actually doesn't mean cartographic scale; it means meters per pixel.
Scale is how many meters in 1 pixel. Larger scale means bigger things are smaller on the screen.
Scale of 1 means 1 pixel == 1 meter.
Scale of 10 means 1 pixel == 10 meters.
*/
float scale;
id tileSource;
... ...
... ... @@ -29,12 +29,12 @@
#import "RMTileImage.h"
@interface RMWebTileImage : RMTileImage {
// Before image is completely loaded a proxy image can be used.
// This will typically be a boilerplate image or a zoomed in or zoomed out version of another image.
/// Before image is completely loaded a proxy image can be used.
/// This will typically be a boilerplate image or a zoomed in or zoomed out version of another image.
RMTileImage *proxy;
NSURLConnection *connection;
// Data accumulator during loading.
/// Data accumulator during loading.
NSMutableData *data;
}
... ...
... ... @@ -679,7 +679,7 @@
);
runOnlyForDeploymentPostprocessing = 0;
shellPath = /bin/sh;
shellScript = "# shell script goes here\n# Append the proper input/output directories and docset info to the config file.\n# This works even though values are assigned higher up in the file. Easier than sed.\n\ncp $SOURCE_ROOT/routeme.doxygen $TEMP_DIR/doxygen.config\n\necho \"INPUT = $SOURCE_ROOT\" >> $TEMP_DIR/doxygen.config\necho \"OUTPUT_DIRECTORY = $SYMROOT/RouteMeDoxygen\" >> $TEMP_DIR/doxygen.config\n#echo \"GENERATE_DOCSET = YES\" >> $TEMP_DIR/doxygen.config\n#echo \"DOCSET_BUNDLE_ID = com.mycompany.DoxygenExample\" >> $TEMP_DIR/doxygen.config\n\n# Run doxygen on the updated config file.\n\n$DOXYGEN_PATH $TEMP_DIR/doxygen.config\n\nexit 0\n";
shellScript = "# shell script goes here\n# Append the proper input/output directories and docset info to the config file.\n# This works even though values are assigned higher up in the file. Easier than sed.\n\ncp $SOURCE_ROOT/routeme.doxygen $TEMP_DIR/doxygen.config\n\necho \"INPUT = $SOURCE_ROOT\" >> $TEMP_DIR/doxygen.config\necho \"OUTPUT_DIRECTORY = $SYMROOT/RouteMeDoxygen\" >> $TEMP_DIR/doxygen.config\n#echo \"GENERATE_DOCSET = YES\" >> $TEMP_DIR/doxygen.config\n#echo \"DOCSET_BUNDLE_ID = com.mycompany.DoxygenExample\" >> $TEMP_DIR/doxygen.config\n\n# Run doxygen on the updated config file.\n\n$DOXYGEN_PATH $TEMP_DIR/doxygen.config\n\nopen $SYMROOT/RouteMeDoxygen/html/index.html\n\nexit 0\n";
};
386676E00F6B73DA00C56B17 /* ShellScript */ = {
isa = PBXShellScriptBuildPhase;
... ...