mirror of
https://github.com/darlinghq/fmdb.git
synced 2024-11-27 06:20:34 +00:00
Only run appledoc on the .h files.
This commit is contained in:
parent
1009892cf6
commit
b044f2a7c7
@ -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.
|
||||
|
@ -183,10 +183,14 @@ static FMDBExecuteBulkSQLCallbackBlock execCallbackBlock;
|
||||
#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;
|
||||
|
Loading…
Reference in New Issue
Block a user