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 @@ @@ -111,6 +111,7 @@
111 111
112 -(void) didReceiveMemoryWarning 112 -(void) didReceiveMemoryWarning
113 { 113 {
  114 + LogMethod();
114 } 115 }
115 116
116 -(NSString *)uniqueTilecacheKey 117 -(NSString *)uniqueTilecacheKey
@@ -41,7 +41,7 @@ @@ -41,7 +41,7 @@
41 - (id) initWithSource: (id<RMTileSource>) source; 41 - (id) initWithSource: (id<RMTileSource>) source;
42 - (void) didReceiveMemoryWarning; 42 - (void) didReceiveMemoryWarning;
43 43
44 -// Bleah ugly name. 44 +/// Bleah ugly name.
45 + (RMCachedTileSource*) cachedTileSourceWithSource: (id<RMTileSource>) source; 45 + (RMCachedTileSource*) cachedTileSourceWithSource: (id<RMTileSource>) source;
46 46
47 - (id<RMTileSource>) underlyingTileSource; 47 - (id<RMTileSource>) underlyingTileSource;
@@ -105,6 +105,7 @@ @@ -105,6 +105,7 @@
105 105
106 - (void) didReceiveMemoryWarning 106 - (void) didReceiveMemoryWarning
107 { 107 {
  108 + LogMethod();
108 [cache didReceiveMemoryWarning]; 109 [cache didReceiveMemoryWarning];
109 } 110 }
110 111
@@ -163,6 +163,7 @@ @@ -163,6 +163,7 @@
163 163
164 -(void)didReceiveMemoryWarning 164 -(void)didReceiveMemoryWarning
165 { 165 {
  166 + LogMethod();
166 if (self.databasePath==nil) { 167 if (self.databasePath==nil) {
167 RMLog(@"unknown db path, unable to reinitialize dao!"); 168 RMLog(@"unknown db path, unable to reinitialize dao!");
168 return; 169 return;
@@ -31,13 +31,13 @@ @@ -31,13 +31,13 @@
31 @class RMProjection; 31 @class RMProjection;
32 32
33 @interface RMFractalTileProjection : NSObject<RMMercatorToTileProjection> { 33 @interface RMFractalTileProjection : NSObject<RMMercatorToTileProjection> {
34 - // Maximum zoom for which our tile server stores images 34 + /// Maximum zoom for which our tile server stores images
35 int maxZoom; 35 int maxZoom;
36 36
37 - // Mercator bounds of the earth 37 + /// Mercator bounds of the earth
38 RMXYRect bounds; 38 RMXYRect bounds;
39 39
40 - // Normally 256. This class assumes tiles are square. 40 + /// Normally 256. This class assumes tiles are square.
41 int tileSideLength; 41 int tileSideLength;
42 42
43 // The deal is, we have a scale which stores how many mercator gradiants per pixel 43 // The deal is, we have a scale which stores how many mercator gradiants per pixel
@@ -32,6 +32,10 @@ @@ -32,6 +32,10 @@
32 #if TARGET_OS_IPHONE 32 #if TARGET_OS_IPHONE
33 #import <CoreLocation/CoreLocation.h> 33 #import <CoreLocation/CoreLocation.h>
34 34
  35 +/*! \struct RMLatLongBounds
  36 + Specifies a region by northwest and southeast corners.
  37 + Note: northWest and southEast will change to northeast and southwest (note spelling and corner changes) after 0.5 to keep right-handed coordinate system
  38 + */
35 typedef struct { 39 typedef struct {
36 CLLocationCoordinate2D northWest; 40 CLLocationCoordinate2D northWest;
37 CLLocationCoordinate2D southEast; 41 CLLocationCoordinate2D southEast;
@@ -73,14 +73,14 @@ enum { @@ -73,14 +73,14 @@ enum {
73 { 73 {
74 // TODO: Also support NSView. 74 // TODO: Also support NSView.
75 75
76 - // This is the underlying UIView's layer. 76 + /// This is the underlying UIView's layer.
77 CALayer *layer; 77 CALayer *layer;
78 78
79 RMMarkerManager *markerManager; 79 RMMarkerManager *markerManager;
80 RMMapLayer *background; 80 RMMapLayer *background;
81 RMLayerSet *overlay; 81 RMLayerSet *overlay;
82 82
83 - // Latlong is calculated dynamically from mercatorBounds. 83 + /// Latlong is calculated dynamically from mercatorBounds.
84 RMProjection *projection; 84 RMProjection *projection;
85 85
86 id<RMMercatorToTileProjection> mercatorToTileProjection; 86 id<RMMercatorToTileProjection> mercatorToTileProjection;
@@ -271,6 +271,7 @@ @@ -271,6 +271,7 @@
271 271
272 - (void) didReceiveMemoryWarning 272 - (void) didReceiveMemoryWarning
273 { 273 {
  274 + LogMethod();
274 [tileSource didReceiveMemoryWarning]; 275 [tileSource didReceiveMemoryWarning];
275 } 276 }
276 277
@@ -135,8 +135,8 @@ typedef struct { @@ -135,8 +135,8 @@ typedef struct {
135 BOOL _contentsIsSet; // "contents" must be set, but is initialized lazily to allow apps to override defaults in -awakeFromNib 135 BOOL _contentsIsSet; // "contents" must be set, but is initialized lazily to allow apps to override defaults in -awakeFromNib
136 } 136 }
137 137
138 -// Any other functionality you need to manipulate the map you can access through this  
139 -// property. The RMMapContents class holds the actual map bits. 138 +/// Any other functionality you need to manipulate the map you can access through this
  139 +/// property. The RMMapContents class holds the actual map bits.
140 @property (nonatomic, retain) RMMapContents *contents; 140 @property (nonatomic, retain) RMMapContents *contents;
141 141
142 @property (nonatomic, retain, readonly) RMMarkerManager *markerManager; 142 @property (nonatomic, retain, readonly) RMMarkerManager *markerManager;
@@ -547,7 +547,8 @@ @@ -547,7 +547,8 @@
547 // Must be called by higher didReceiveMemoryWarning 547 // Must be called by higher didReceiveMemoryWarning
548 - (void)didReceiveMemoryWarning 548 - (void)didReceiveMemoryWarning
549 { 549 {
550 - [contents didReceiveMemoryWarning]; 550 + LogMethod();
  551 + [contents didReceiveMemoryWarning];
551 } 552 }
552 553
553 - (void)setFrame:(CGRect)frame 554 - (void)setFrame:(CGRect)frame
@@ -66,6 +66,7 @@ @@ -66,6 +66,7 @@
66 66
67 -(void) didReceiveMemoryWarning 67 -(void) didReceiveMemoryWarning
68 { 68 {
  69 + LogMethod();
69 [cache removeAllObjects]; 70 [cache removeAllObjects];
70 } 71 }
71 72
@@ -39,7 +39,7 @@ typedef enum { @@ -39,7 +39,7 @@ typedef enum {
39 39
40 @protocol RMTileCache<NSObject> 40 @protocol RMTileCache<NSObject>
41 41
42 -// Returns the cached image if it exists. nil otherwise. 42 +/// Returns the cached image if it exists. nil otherwise.
43 -(RMTileImage*) cachedImage:(RMTile)tile; 43 -(RMTileImage*) cachedImage:(RMTile)tile;
44 -(void)didReceiveMemoryWarning; 44 -(void)didReceiveMemoryWarning;
45 45
@@ -59,10 +59,10 @@ typedef enum { @@ -59,10 +59,10 @@ typedef enum {
59 59
60 +(NSNumber*) tileHash: (RMTile)tile; 60 +(NSNumber*) tileHash: (RMTile)tile;
61 61
62 -// Add tile to cache 62 +/// Add tile to cache
63 -(void)addTile: (RMTile)tile WithImage: (RMTileImage*)image; 63 -(void)addTile: (RMTile)tile WithImage: (RMTileImage*)image;
64 64
65 -// Add another cache to the chain 65 +/// Add another cache to the chain
66 -(void)addCache: (id<RMTileCache>)cache; 66 -(void)addCache: (id<RMTileCache>)cache;
67 67
68 -(void)didReceiveMemoryWarning; 68 -(void)didReceiveMemoryWarning;
@@ -133,6 +133,7 @@ @@ -133,6 +133,7 @@
133 133
134 -(void)didReceiveMemoryWarning 134 -(void)didReceiveMemoryWarning
135 { 135 {
  136 + LogMethod();
136 for (id<RMTileCache> cache in caches) 137 for (id<RMTileCache> cache in caches)
137 { 138 {
138 [cache didReceiveMemoryWarning]; 139 [cache didReceiveMemoryWarning];
@@ -56,8 +56,7 @@ @@ -56,8 +56,7 @@
56 56
57 -(void) addTile: (RMTile) tile WithImage: (RMTileImage *)image At: (CGRect) screenLocation; 57 -(void) addTile: (RMTile) tile WithImage: (RMTileImage *)image At: (CGRect) screenLocation;
58 -(void) addTile: (RMTile) tile At: (CGRect) screenLocation; 58 -(void) addTile: (RMTile) tile At: (CGRect) screenLocation;
59 -// Add tiles inside rect protected to bounds. Return rectangle containing bounds  
60 -// extended to full tile loading area 59 +/// Add tiles inside rect protected to bounds. Return rectangle containing bounds extended to full tile loading area
61 -(CGRect) addTiles: (RMTileRect)rect ToDisplayIn:(CGRect)bounds; 60 -(CGRect) addTiles: (RMTileRect)rect ToDisplayIn:(CGRect)bounds;
62 61
63 -(RMTileImage*) imageWithTile: (RMTile) tile; 62 -(RMTileImage*) imageWithTile: (RMTile) tile;
@@ -42,9 +42,12 @@ @@ -42,9 +42,12 @@
42 // Size in pixels 42 // Size in pixels
43 // CGSize viewSize; 43 // CGSize viewSize;
44 44
45 - // Scale is how many meters in 1 pixel. Larger scale means bigger things are smaller on the screen.  
46 - // Scale of 1 means 1 pixel == 1 meter.  
47 - // Scale of 10 means 1 pixel == 10 meters. 45 + /*! \brief "scale" as of version 0.4/0.5 actually doesn't mean cartographic scale; it means meters per pixel.
  46 +
  47 + Scale is how many meters in 1 pixel. Larger scale means bigger things are smaller on the screen.
  48 + Scale of 1 means 1 pixel == 1 meter.
  49 + Scale of 10 means 1 pixel == 10 meters.
  50 + */
48 float scale; 51 float scale;
49 52
50 id tileSource; 53 id tileSource;
@@ -29,12 +29,12 @@ @@ -29,12 +29,12 @@
29 #import "RMTileImage.h" 29 #import "RMTileImage.h"
30 30
31 @interface RMWebTileImage : RMTileImage { 31 @interface RMWebTileImage : RMTileImage {
32 - // Before image is completely loaded a proxy image can be used.  
33 - // This will typically be a boilerplate image or a zoomed in or zoomed out version of another image. 32 + /// Before image is completely loaded a proxy image can be used.
  33 + /// This will typically be a boilerplate image or a zoomed in or zoomed out version of another image.
34 RMTileImage *proxy; 34 RMTileImage *proxy;
35 35
36 NSURLConnection *connection; 36 NSURLConnection *connection;
37 - // Data accumulator during loading. 37 + /// Data accumulator during loading.
38 NSMutableData *data; 38 NSMutableData *data;
39 } 39 }
40 40
@@ -679,7 +679,7 @@ @@ -679,7 +679,7 @@
679 ); 679 );
680 runOnlyForDeploymentPostprocessing = 0; 680 runOnlyForDeploymentPostprocessing = 0;
681 shellPath = /bin/sh; 681 shellPath = /bin/sh;
682 - 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"; 682 + 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";
683 }; 683 };
684 386676E00F6B73DA00C56B17 /* ShellScript */ = { 684 386676E00F6B73DA00C56B17 /* ShellScript */ = {
685 isa = PBXShellScriptBuildPhase; 685 isa = PBXShellScriptBuildPhase;