Overview and Descriptions Not Parsing, related to Unknown escape sequence? #272

Closed
bradeaton opened this Issue Nov 4, 2012 · 7 comments

Comments

Projects
None yet
4 participants

I'm brand new to the project, but I think it's fantastic so far.

One problem I've run into. The "Overview" section at the top of a class reference and the "Discussion" sections for properties and methods aren't parsing and showing up in the help doc. I'm pretty sure I have the comments syntax correct because I get the same results when I aim appledoc at one of the appledoc source files (GBTask for example). If I add @discussion to the beginning of the second paragraphs in the comments, it will work.

This is the command line I'm using:
appledoc --company-id com.bradeaton --project-company "Brad Eaton" --project-name "DialControl" --output ~/help --repeat-first-par FE*.h

I'm wondering if this is related to a single warning I'm getting when compiling:
Unknown escape sequence '\s' at line 440 in GBCommentsProcessor.m

439     if (index.location == NSNotFound) {
440         index = [description rangeOfString:@"\s+"];
441     }

Looks like that's a RegExKitLite thing? I changed that to be @"\\s+" and the compiler warning went away, but it did not fix the problem.

I am currently on Mac OS 10.8.2 using Xcode 4.5.1.

Thanks in advance for any advice.

Owner

tomaz commented Nov 4, 2012

I got this reported already, so it must be one of the recent contributions that brokeths functionality. Will take a look

tomaz closed this in 3d23114 Nov 5, 2012

Owner

tomaz commented Nov 5, 2012

Should work now - it was indeed broken with one of the recent contributions; for 3.0 I'll require all unit tests passing before accepting (will also have to maintain good suite of unit tests :)

Update to lastest commit. If you still have issues, let me know.

Issue resolved for me, thanks! The build number didn't change, though?

dahlenu commented Dec 13, 2012

This is exactly what happens to me. The Overview section is missing from the output. I use Xcode 4.5.2 on OS X 10.8.2 with appledoc 2.1 (build 840) downloaded and compiled today. Everything else works fine. Has this bug been re-introduced or am I doing something wrong?

Owner

tomaz commented Dec 14, 2012

It's obviously been introduced, I had many reports already. Will take a
look ASAP.

Tom

On Thursday, December 13, 2012, dahlenu wrote:

This is exactly what happens to me. The Overview section is missing from
the output. I use Xcode 4.5.2 on OS X 10.8.2 with appledoc 2.1 (build 840)
downloaded and compiled today. Everything else works fine. Has this bug
been re-introduced or am I doing something wrong?


Reply to this email directly or view it on GitHubhttps://github.com/tomaz/appledoc/issues/272#issuecomment-11354919.

Owner

tomaz commented Dec 14, 2012

Fixed and pushed to GitHub.

Tom

On Fri, Dec 14, 2012 at 7:45 AM, Tomaz Kragelj tkragelj@gmail.com wrote:

It's obviously been introduced, I had many reports already. Will take a
look ASAP.

Tom

On Thursday, December 13, 2012, dahlenu wrote:

This is exactly what happens to me. The Overview section is missing from
the output. I use Xcode 4.5.2 on OS X 10.8.2 with appledoc 2.1 (build 840)
downloaded and compiled today. Everything else works fine. Has this bug
been re-introduced or am I doing something wrong?


Reply to this email directly or view it on GitHubhttps://github.com/tomaz/appledoc/issues/272#issuecomment-11354919.

dahlenu commented Dec 14, 2012

Seems to work fine now. Thank you very much!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment