Permalink
Browse files

Docs

  • Loading branch information...
1 parent 3a0a635 commit d8a0d44b59096ed6dcbf2bd87d630d4f0a8c624c @mikkelee committed Apr 30, 2012
Showing with 34 additions and 1 deletion.
  1. +3 −1 Gedcom/GCContext.h
  2. +9 −0 Gedcom/GCFile.h
  3. +22 −0 Gedcom/GCObject.h
View
@@ -38,7 +38,7 @@
*/
- (GCEntity *)entityForXref:(NSString *)xref;
-/// @name Registering Xrefs
+/// @name Registering callbacks
/** Register a callback for an xref.
@@ -49,6 +49,8 @@
*/
- (void)registerBlock:(void (^)(NSString *xref))block forXref:(NSString *)xref;
+/// @name Registering Xrefs
+
/** Stores an xref for an entity.
If a callback has been registered for the xref, it is issued.
View
@@ -121,6 +121,15 @@
@interface GCFile (GCValidationMethods)
+/// @name Validating files
+
+/** Returns whether the receiver is a valid Gedcom file.
+
+ If the file is invalid, the error pointer will be updated with an NSError describing the problem.
+
+ @param error A pointer to an NSError object
+ @return `YES` if the file is valid, otherwise `NO`.
+ */
- (BOOL)validateFile:(NSError **)error;
@end
View
@@ -203,13 +203,35 @@
@interface GCObject (GCCodingHelpers)
+//TODO should probably not be documented at all...
+
+/// @name Internal methods
+
+/** Used internally.
+
+ @param aDecoder Used internally.
+ */
- (void)decodeProperties:(NSCoder *)aDecoder;
+
+/** Used internally.
+
+ @param aCoder Used internally.
+ */
- (void)encodeProperties:(NSCoder *)aCoder;
@end
@interface GCObject (GCValidationMethods)
+/// @name Validating objects
+
+/** Returns whether the receiver is a valid Gedcom object.
+
+ If the object is invalid, the error pointer will be updated with an NSError describing the problem.
+
+ @param error A pointer to an NSError object
+ @return `YES` if the object is valid, otherwise `NO`.
+ */
- (BOOL)validateObject:(NSError **)error;
@end

0 comments on commit d8a0d44

Please sign in to comment.