File icons are used for classes (and everything produced by AppleDoc) in the "Browse" view of Organizer, yet when searching, they do come up with the class icon "C". Would be super great to have the browse show these also with the class icon. Thanks!

Xcode does not display QuickHelp for the DocSet I created with AppleDoc. The other parts of the Xcode integration work fine - I can see the project in the Help menu and the files are found when I right-click a keyword and choose "Find text in documentation".

It does not seem to a problem with my setup - I asked other people to install my docset, and they reported the same results.

Can you set the DocSetPlatformFamily key to default to "appledoc"? Having "appledoc" as the docset platform allows Dash (http://kapeli.com/dash) to recognise a docset as Appledoc-generated and enable extra features for it (table of contents and click-to-copy). Thanks!

Running appledoc on OSX 10.8 produces this crash:

2012-03-08 18:31:51.507 appledoc[24139:707] -[__NSCFConstantString code]: unrecognized selector sent to instance 0x7fff76c3c590
appledoc version: 2.0.4 (build 703)

Oops, something went wrong...
NSInvalidArgumentException: -[__NSCFConstantString code]: unrecognized selector sent to instance 0x7fff76c3c590
  @ 0   CoreFoundation                      0x00007fff8ceeaf06 __exceptionPreprocess + 198
  @ 1   libobjc.A.dylib                     0x00007fff8a71579a objc_exception_throw + 43
  @ 2   CoreFoundation                      0x00007fff8cf842aa -[NSObject(NSObject) doesNotRecognizeSelector:] + 186
  @ 3   CoreFoundation                      0x00007fff8ced956e ___forwarding___ + 414
  @ 4   CoreFoundation                      0x00007fff8ced9358 _CF_forwarding_prep_0 + 232
  @ 5   appledoc                            0x000000010c735e2b +[NSException(GBException) reasonWithError:message:] + 43
  @ 6   appledoc                            0x000000010c735dd0 +[NSException(GBException) raise:format:] + 480
  @ 7   Foundation                          0x00007fff89d15bd2 -[NSConcreteTask launchWithDictionary:] + 409
  @ 8   appledoc                            0x000000010c79c571 -[GBTask runCommand:arguments:block:] + 1617
  @ 9   appledoc                            0x000000010c798eba -[GBDocSetOutputGenerator indexDocSet:] + 426
  @ 10  appledoc                            0x000000010c796f7d -[GBDocSetOutputGenerator generateOutputWithStore:error:] + 541
  @ 11  appledoc                            0x000000010c775d03 __42-[GBGenerator runGeneratorStepsWithStore:]_block_invoke_0 + 803
  @ 12  CoreFoundation                      0x00007fff8cee3906 __NSArrayEnumerate + 582
  @ 13  appledoc                            0x000000010c775959 -[GBGenerator runGeneratorStepsWithStore:] + 713
  @ 14  appledoc                            0x000000010c77531e -[GBGenerator generateOutputFromStore:] + 414
  @ 15  appledoc                            0x000000010c72b963 -[GBAppledocApplication application:runWithArguments:] + 2419
  @ 16  appledoc                            0x000000010c7290d8 -[DDCliApplication runWithClass:] + 360
  @ 17  appledoc                            0x000000010c729427 DDCliAppRunWithClass + 103
  @ 18  appledoc                            0x000000010c728298 main + 56
  @ 19  appledoc                            0x000000010c728254 start + 52
Command /bin/sh failed with exit code 250

I don't think the issue is Xcode, though.

Symptom: Running Appledoc build does not result in docset being available in XCode's (still!) inferior docset viewer.

Resolution: Reverting to commit aaca91b9b074d59718ea87e574fa4973022e2160 fixes the issue.

Hiyas

If this has already been answered or asked before, I apologize, but a quick search for "xcode warnings" hasn't really dug up much. Anyways, I am sure this is a configuration problem on my own, but I can't figure it out how to make it correctly.

What I want to do is to run appledoc and have it log everything it finds that isn't documented out so that XCode can pick it up when started using an Aggregate.

I managed to make appledoc working and producing happily documentation with this run script in the aggregate:

if [ -e "/usr/local/bin/appledoc" ]
then
/usr/local/bin/appledoc --create-html --install-docset --project-name "RMTXKit" --project-company "ABACUS Research AG" --company-id "ch.abacus" --output "/Users/misteli/dev/objc/iPhone/Libraries/RMTXKit/Documentation" --publish-docset –logformat=xcode --verbose xcode --keep-undocumented-objects --keep-undocumented-members --keep-intermediate-files --warn-undocumented-object --warn-undocumented-member --warn-empty-description --warn-unknown-directive --merge-categories --merge-category-comment --search-undocumented-doc --warn-missing-arg --no-repeat-first-par --no-warn-invalid-crossref --ignore "*.m" --ignore "*Test.h" --ignore "*Tests.h" --exit-threshold 2 --docset-package-url "http://www.abacus.ch/docs" --docset-feed-url "http://www.abacus.ch/docs" /Users/misteli/dev/objc/iPhone/Libraries/RMTXKit
fi

I experimented around using the $(PROJECTNAME) variables and more, but for the sake of being able to quickly run it in the console, this current version doesn't use that.

So.. this builds up all my documentation but it doesn't log anything that isn't documented. Also, if I simply copy/paste the call to a console, appledoc happily runs, creates the documentation but whilst its running it doesn't log anything out other than its version and build number.

What did I forget to add?

Thanks!

When a method is opt+click'd, there is a quickhelp bubble. There used to be an option in this bubble to read more in the organizer, but this option is no longer available for appledoc-generated documentation, starting with Xcode 4.4.

The Exit value for the new build appears to be 245 if successful or 1 if not rather than zero and the values posted in the changelog, excerpt from calling shell script in Xcode build below:

!/bin/sh

MakeDocumentation.sh

iHF iPhone Library

Created by David Jehring on 28/04/2011.

Copyright 2011 Black Pear Software Ltd. All rights reserved.

KEEP_FILES command line paramenter only populated if local html directory exists

if [ -d "${HOME}/Development/Devhelp" ]; then KEEP_FILES="--keep-intermediate-files" else KEEP_FILES="" fi

PUBLISHDIR=${HOME}/Development/Devhelp/bpiHF

/usr/local/bin/appledoc
--project-name "Black Pear iHF"
-o "${SOURCE_ROOT}/help"
--docset-bundle-name "Black Pear iHF"
--merge-categories
--verbose 3
--docset-feed-url http://blackpear.com/devhelp/%DOCSETATOMFILENAME
--docset-package-url http://blackpear.com/devhelp/%DOCSETPACKAGEFILENAME
--publish-docset
"${KEEP_FILES}"
--print-settings
"${SOURCE_ROOT}/iHF/Interface/iHRDataInterface.h"
"${SOURCE_ROOT}/iHF/Plugin Support/iHFPrescribingDelegate.h"
"${SOURCE_ROOT}/iHF/Plugin Support/iHFPrescribingProtocol.h"
"${SOURCE_ROOT}/iHF/Plugin Support/iHFCodeBrowsingDelegate.h"
"${SOURCE_ROOT}/iHF/Plugin Support/iHFCodeBrowsingProtocol.h"
"${SOURCE_ROOT}/iHF/Plugin Support/iHFCodedItemExt.h"
"${SOURCE_ROOT}/iHF/Categories/iHRPersistableObjectExt.h"

RET=$? if [ $RET -ne 245 ];then echo "Apple doc failed with $RET" exit $RET fi

This would not be attached to any class, category or protocol. It should prefferably be completely decoupled from source files - as a set of "external" files created outside picked up by appledoc and copied to output directory.

Ideally, this should be somewhat processed by appledoc for cross references and use the same markdown syntax.

Additionally, there should be a way to link to this static documentation from within standard source code comments. It would also be nice to have it linked as companion guide so that it would also get listed in doc set.

Xcode 7.2 OS: El Capitan 10.11.3

I follow readme to start documentation, but on sudo sh install-appledoc.sh a got a install failed.

ld: library not found for -lDiscount
clang: error: linker command failed with exit code 1 (use -v to see invocation)

** INSTALL FAILED **


The following build commands failed:
    Ld /tmp/appledoc.dst/usr/local/bin/appledoc normal x86_64
(1 failure)

Obviously i install pod and project build correctly on xcode but not with sh, so i dont get the binary exported It's a bug or i miss something ?

I am new to appledoc, and I understand the documentation for appledoc was not migrated when you moved to a newer site.

It's a bit difficult without documentation, and a documentation tool with no documentation is a bit ironic ;)

I know GitHub has a wiki feature. How hard would it be to as least copy paste the old doc here and take it from there slowly?

Warning: No available formula with the name "appledoc". Did you mean apidoc?
==> Searching for similarly named formulae...
This similarly named formula was found:
apidoc
To install it, run:
  brew install apidoc
==> Searching for a previously deleted formula (in the last month)...
Error: No previously deleted formula found.
==> Searching taps on GitHub...
Error: No formulae found in taps.

Hi, rencently I used AppleDoc to generate API doc for Objective-C SDK. It is amazing. But I found it seems to not support @textblock and @code tag. I know appleDoc support to write code block with a tab or 4 (or more) spaces.. But I want to use @textblock or @code because which can show example code in quick help of XCode, as shown below. How can AppleDoc parse @textblock or @code tag?

Hi, AppleDoc, Current, the doc generated by appledoc show the method declaration as below

But I hope it has line break after every paramet, like apple official doc. How can I do?

Development Environment

• Xcode 11.3.1 (11C504)
• macOS Catalina 10.15.4 Beta (19E234g)

Deployment Target

• macOS 10.7

Change Log

• GHUnit is removed because it's a deprecated project.
• XCTest is applied.
• Code coverage is enabled.
• GBLogX... is replaced with GBLog.... GBLogX... is supposed to print the file name that has the log. But DDLog that GBLog... and GBLogX... are using has an issue to print character array. In order to set the file name to nil, some macros are copied into GBLog.h from DDLog. This is a workaround.

Todo

• GBLogXError, GBLogXInfo, and GBLogXWarn don't work with the CocoaLumberjack v1.9.1