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.

Sign up for GitHub

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

Jump to bottom

Improve objc cocoadocs #1866

Closed
sergiocampama opened this issue Jul 28, 2016 · 1 comment
Closed

Improve objc cocoadocs #1866

sergiocampama opened this issue Jul 28, 2016 · 1 comment
Labels
objective-c

Comments

@sergiocampama
Copy link
Contributor

sergiocampama commented Jul 28, 2016 •
edited

They look bad right now http://cocoadocs.org/docsets/Protobuf/3.0.0-beta-4/
@sergiocampama sergiocampama mentioned this issue Jul 28, 2016
Merged
@thomasvl
Copy link
Contributor

thomasvl commented Aug 5, 2016

To expand on the issue:

  • Some files haven't been put in the first format
  • Things currently use /// as the comment market. This works for Xcode's tooltips and docs sidebar, but it seems cocoadocs doesn't support this correctly.

thomasvl pushed a commit that referenced this issue Aug 8, 2016
@sergiocampama @thomasvl
Migrating documentation of the ObjectiveC runtime code to appledoc. (#…
32fadc0 
…1867)

Work for #1866 

Migrates all the public class docs over to appledoc format.  While Xcode is fine with blank lines in `///` comments, appledoc (used by cocoadocs) isn't and was leaving a bunch of info off the doc pages.

The generator still needs to be updated to do this also; that will be a follow up CL.
@sergiocampama sergiocampama mentioned this issue Aug 8, 2016
Merged
liujisi pushed a commit to liujisi/protobuf that referenced this issue Aug 17, 2016
@sergiocampama @liujisi
Migrating documentation of the ObjectiveC runtime code to appledoc. (p…
42ab9b4 
…rotocolbuffers#1867)

Work for protocolbuffers#1866 

Migrates all the public class docs over to appledoc format.  While Xcode is fine with blank lines in `///` comments, appledoc (used by cocoadocs) isn't and was leaving a bunch of info off the doc pages.

The generator still needs to be updated to do this also; that will be a follow up CL.
liujisi pushed a commit to liujisi/protobuf that referenced this issue Aug 17, 2016
@sergiocampama @liujisi
Adds support for appledoc in generated code. (protocolbuffers#1928)
a989501 
Convert mapping of proto comments to appledoc format so they show up in Xcode and cocoadocs.

Fixes protocolbuffers#1866
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
objective-c
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@sergiocampama @thomasvl @xfxyjwf