Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Combine abstract and discussion in page overview #115

Closed
luketheobscure opened this issue Dec 14, 2014 · 5 comments
Closed

Combine abstract and discussion in page overview #115

luketheobscure opened this issue Dec 14, 2014 · 5 comments

Comments

@luketheobscure
Copy link

I've got the following file in my project:

/**
    Protocol for storing information about a diff.

    Two things that kind of suck:
        - As of XCode 6.1.1, There's some kind of bug between the @NSManaged directive, protocols, and the compiler, so we can't set these as actual @NSManaged properties in out models, thus the weird names
        - We have to add the @objc or else the compiler won't let us assign back to these variables, despite having defined setters.
*/

@objc
public protocol Diffable {
    var diffUrlString: String? { get set }
    var diffString: String? { get set }
}

As expected, the whole comment shows up in the "Protocols available globally section" under "Diffable". But if I document the two variables "Diffable" gets it's own section, and we only get the first line of the comment. Removing the blank line gives me two lines of documentation, but we don't get the list. See attached.

Properties not documented:
screen shot 2014-12-14 at 8 01 25 am

Properties documented (documentation is truncated):
screen shot 2014-12-14 at 7 59 22 am

@segiddins
Copy link
Collaborator

@jpsim this seems to be the abstract vs the discussion... Should the partials they're currently in be switched?

@jpsim
Copy link
Collaborator

jpsim commented Dec 17, 2014

I think we should show combined abstract/discussion in both cases, instead of just in the inline view.

@jpsim jpsim changed the title Bug: Documentation gets truncated Combine abstract and discussion in page overview Dec 26, 2014
@jpsim jpsim self-assigned this Dec 26, 2014
@jpsim
Copy link
Collaborator

jpsim commented Dec 26, 2014

Done in f0060d8.

@jpsim jpsim closed this as completed Dec 26, 2014
@luketheobscure
Copy link
Author

I'm not sure this worked. Here's the documentation generated with Jazzy 0.0.19: http://luketheobscure.github.io/BlargBucket/Protocols/Diffable.html

Here's the file that was parsed:
https://github.com/luketheobscure/BlargBucket/blob/master/BlargBucket/Models/Base%20Classes/Diffable.swift

@jpsim
Copy link
Collaborator

jpsim commented Jan 1, 2015

That change hasn't been pushed to rubygems yet. You'll have to run from the current master branch to see the change.

@pigeondotdev pigeondotdev modified the milestone: The Past Nov 22, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants