Fixing broken paths in ASDoc?

ASDoc is frustrating to no end. Have you tried explicitly adding the full package/class name to the @see, i. E: see myPackage.

MyClass#MyProperty To see if that makes a difference? Edit I ran a few tests based on your findings and the internal property marker is working for me. I.

E see #_dispatcher Links directly to that property on the page (no double sub-folder). I think maybe you need to rethink how you're running the command. For instance, my codebase is set up thusly: src /com /bkwld /fetch I typically run asdoc inside "src": asdoc -source-path .

-doc-classes com/bkwld/fetch/Fetch I tried all of these in Fetch. As and they all worked as expected: see FetchItem * @see com.bkwld.utils. Logger * @see #_dispatcher First took me to the FetchItem page, second took me to the Logger page in a different package, and third jumped up the page to the protected methods of Fetch Just out of curiosity...what version of the sdk are you using?

ASDoc is frustrating to no end. Have you tried explicitly adding the full package/class name to the @see, i. E: @see myPackage.

MyClass#MyProperty To see if that makes a difference? Edit I ran a few tests based on your findings and the internal property marker is working for me. I.e.

@see #_dispatcher Links directly to that property on the page (no double sub-folder). I think maybe you need to rethink how you're running the command. For instance, my codebase is set up thusly: /src /com /bkwld /fetch I typically run asdoc inside "src": asdoc -source-path .

-doc-classes com/bkwld/fetch/Fetch I tried all of these in Fetch. As and they all worked as expected: * @see FetchItem * @see com.bkwld.utils. Logger * @see #_dispatcher First took me to the FetchItem page, second took me to the Logger page in a different package, and third jumped up the page to the protected methods of Fetch.

Just out of curiosity...what version of the sdk are you using?

Hmm, it did make a difference... I'll update with the results. – fenomas Jun 2 '09 at 3:55 Added a test, FYI – typeoneerror Jun 3 '09 at 0:31 Thanks VERY much for the testing mate, this sounds solveable. I'm calling ASDoc similarly to you - I keep the batch file in my classpath directory, at the same level as my topmost package ("com" in your example).

I'll add a few version details to my question as well. You're not using FlexBuilder or Eclipse to run ASDoc, right? – fenomas Jun 3 '09 at 7:54 Nope, just command line.

I'm currently running the version bundled with 4.0.0.4021 – typeoneerror Jun 3 '09 at 15:09 I tried the newer 4.0.0.7219 beta version, and all of my issues but one were resolved. This last one, I don't think can be anything but an ASDoc bug, so I think this has all been nothing but an edge case. I'll update the question with details.

– fenomas Jun 3 '09 at 5:28.

I'd guess the problem is your line -doc-sources myPackage Specifying '. ' there instead of 'myPackage' should get it fixed (so make it identical to your source path).

Afraid not, this just makes it try to document all the other source in that folder in addition to the one I'm trying to document. If I move all the other source elsewhere, ASDoc completes without error as before, and the bug is unchanged. – fenomas Jun 1 '09 at 12:23 Hmm, I would not know what to suggest otherwise.

The use of a packagename in -doc-sources definitely feels wrong to me. – Simon Groenewolt Jun 1 '09 at 14:20 I tried removing the -doc-sources line entirely, and including classes via -doc-classes instead... as in, "-doc-classes packageName. ClassName".

It didn't seem to have any effect on the bug though. Would that be a more normal way to be calling asdoc? – fenomas Jun 2 '09 at 4:17.

I have written a simple Python script that fixes the paths incorrectly generated by asdoc in the case mentioned mentioned above. Namely, if there is a method myMethod(v:MyClass,...) asdoc incorrectly generates the link href="../mypackage:Myclass" The script will fix this replacing the : by a / I should notice that the docs I am generating have a pretty "flat" structure, that is, a single package with a bunch of classes. I have no idea if the fix works with more complex documentation structures.

Anyway, if anyone wants to try the script, I'll be glad to send it.

I find asdoc extremely frustrating, I experience the same problem when I referrer to a method in the same package. Another annoying thing is the @example tag where the outline of your code can be a mess sometimes, but there it does not end. I have spend more time on writing the javadoc in my code than writing the actual code, and then it somehow ignores all my private variables and private functions, despite the fact I do not use the @private keyword, it's probably me something missing here, but very logical it does not seem to me.

If I would have written my documentation by hand using notepad I would be finished 3 times already, and I would not have to search between the comments for code in my as files, since single line comments are ignored as well. So, at least I got rid of my frustration now and my blood pressure got back to a normal level. Time to give it another try.

:-p.

I am creating the documentation of my flex project using ASDoc and having some issues with the bindable metatag. ASDoc doesn't document public Bindable values unless the Bindable tag has an event name associated with it. ASDoc prepends random strings to the names of protected Bindable values if the bindable tag doesn't have an event name associated with it.

To sum it up, ASDoc is not happy with Bindable tags without an event name. The easy solution, it seems, would be to specify an event name whenever you declare something as Bindable. But flex docs say that if you specify an event name with the Bindable tag, then "you are responsible for generating and dispatching the event".

I cant really gove you an answer,but what I can give you is a way to a solution, that is you have to find the anglde that you relate to or peaks your interest. A good paper is one that people get drawn into because it reaches them ln some way.As for me WW11 to me, I think of the holocaust and the effect it had on the survivors, their families and those who stood by and did nothing until it was too late.

Related Questions