Преглед на файлове

Only run appledoc on the .h files.

robertmryan преди 11 години
родител
ревизия
b044f2a7c7
променени са 2 файла, в които са добавени 10 реда и са изтрити 6 реда
  1. 2 2
      CHANGES_AND_TODO_LIST.txt
  2. 8 4
      src/fmdb/FMDatabase.m

+ 2 - 2
CHANGES_AND_TODO_LIST.txt

@@ -41,11 +41,11 @@ If you would like to contribute some code- awesome!  I just ask that you make it
 
         - To build that HTML documentation, once you've installed `appledoc`, you issue the command:
 
-             appledoc --project-name FMDB --project-company ccgus --explicit-crossref --no-merge-categories --output ../Documentation .
+             appledoc --project-name FMDB --project-company ccgus --explicit-crossref --no-merge-categories --output ../Documentation --ignore *.m .
 
         - If you want online help integrated right into Xcode, you can issue the command:
 
-             appledoc --project-name FMDB --project-company ccgus --explicit-crossref --merge-categories --install-docset --output ../Documentation .
+             appledoc --project-name FMDB --project-company ccgus --explicit-crossref --merge-categories --install-docset --output --ignore *.m ../Documentation .
 
 2013.05.24
     Merged in Chris Wright's date format additions to FMDatabase.

+ 8 - 4
src/fmdb/FMDatabase.m

@@ -183,10 +183,14 @@ - (BOOL)close {
 #pragma mark Busy handler routines
 
 // NOTE: appledoc seems to choke on this function for some reason;
-//       so when generating documentation, you might want to temporarily
-//       comment out this function. It's a known bug that it has problems
-//       with C functions within a class implementation, but for some
-//       reason, only this C function causes problems; the rest don't!
+//       so when generating documentation, you might want to ignore the
+//       .m files so that it only documents the public interfaces outlined
+//       in the .h files.
+//
+//       This is a known appledoc bug that it has problems with C functions
+//       within a class implementation, but for some reason, only this
+//       C function causes problems; the rest don't. Anyway, ignoring the .m
+//       files with appledoc will prevent this problem from occurring.
 
 static int FMDBDatabaseBusyHandler(void *f, int count) {
     FMDatabase *self = (__bridge FMDatabase*)f;