appledoc icon indicating copy to clipboard operation
appledoc copied to clipboard

running appledoc 2 times in a row does not render the same result

Open rrrus opened this issue 10 years ago • 3 comments

I'm not sure if there is something about our codebase (185 .m files, 204 .h files) but appledoc renders a different result each and every time. Sometimes it misses source files, sometimes it changes an href from "path#anchor" to "#anchor", sometimes it adds/removes a hyperlink around a keyword, sometimes it misses methods of a class.

The script that runs appledoc deletes any previous output folder before running each time. It then invokes appledoc like so:

appledoc --project-name "xxxxx" --project-company "Padopolis, Inc" --company-id com.padopolis --docset-bundle-filename xxxxxxxxx --output ${docspath} --keep-intermediate-files --ignore 3rdParty .

Regression: MacOS 10.9.3 Xcode 5.1.1 appledoc 2.1 (unknown commit) & 2.2 (9678ac8)

rrrus avatar Jun 24 '14 00:06 rrrus

Interesting. Never noticed this behavior. Don't recollect there's some randomization in any of the code. Are there any warnings in console?

tomaz avatar Jun 24 '14 06:06 tomaz

I've got a minimal test to repro the issue:

https://dl.dropboxusercontent.com/u/82811377/appledoc-difftest.zip

unzip, cd into appledoc-difftest folder, run ./runtest repeatedly until issue occurs. Sometimes it happens immediately. Sometimes it takes many tries. Usually it happens in 2-3 tries.

This only reproduces the missing <a> tag issue, but not the missing files or changing anchor links.

I included both appledoc 2.1 & 2.2 that I reproduced it with.

rrrus avatar Jun 24 '14 20:06 rrrus

Same for us.

Wild stab in the dark: Is AppleDoc iterating over containers that don't have a guaranteed ordering (NSDictionaries, NSSets, etc) when rendering?

MSch avatar Nov 06 '14 17:11 MSch