Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Docs

  • Loading branch information...
commit d8a0d44b59096ed6dcbf2bd87d630d4f0a8c624c 1 parent 3a0a635
Mikkel Eide Eriksen authored
4 Gedcom/GCContext.h
@@ -38,7 +38,7 @@
38 38 */
39 39 - (GCEntity *)entityForXref:(NSString *)xref;
40 40
41   -/// @name Registering Xrefs
  41 +/// @name Registering callbacks
42 42
43 43 /** Register a callback for an xref.
44 44
@@ -49,6 +49,8 @@
49 49 */
50 50 - (void)registerBlock:(void (^)(NSString *xref))block forXref:(NSString *)xref;
51 51
  52 +/// @name Registering Xrefs
  53 +
52 54 /** Stores an xref for an entity.
53 55
54 56 If a callback has been registered for the xref, it is issued.
9 Gedcom/GCFile.h
@@ -121,6 +121,15 @@
121 121
122 122 @interface GCFile (GCValidationMethods)
123 123
  124 +/// @name Validating files
  125 +
  126 +/** Returns whether the receiver is a valid Gedcom file.
  127 +
  128 + If the file is invalid, the error pointer will be updated with an NSError describing the problem.
  129 +
  130 + @param error A pointer to an NSError object
  131 + @return `YES` if the file is valid, otherwise `NO`.
  132 + */
124 133 - (BOOL)validateFile:(NSError **)error;
125 134
126 135 @end
22 Gedcom/GCObject.h
@@ -203,13 +203,35 @@
203 203
204 204 @interface GCObject (GCCodingHelpers)
205 205
  206 +//TODO should probably not be documented at all...
  207 +
  208 +/// @name Internal methods
  209 +
  210 +/** Used internally.
  211 +
  212 + @param aDecoder Used internally.
  213 + */
206 214 - (void)decodeProperties:(NSCoder *)aDecoder;
  215 +
  216 +/** Used internally.
  217 +
  218 + @param aCoder Used internally.
  219 + */
207 220 - (void)encodeProperties:(NSCoder *)aCoder;
208 221
209 222 @end
210 223
211 224 @interface GCObject (GCValidationMethods)
212 225
  226 +/// @name Validating objects
  227 +
  228 +/** Returns whether the receiver is a valid Gedcom object.
  229 +
  230 + If the object is invalid, the error pointer will be updated with an NSError describing the problem.
  231 +
  232 + @param error A pointer to an NSError object
  233 + @return `YES` if the object is valid, otherwise `NO`.
  234 + */
213 235 - (BOOL)validateObject:(NSError **)error;
214 236
215 237 @end

0 comments on commit d8a0d44

Please sign in to comment.
Something went wrong with that request. Please try again.