Yardoc for ruby api

Jim

As another experiment in collaborative documentation of SketchUp's Ruby API, I set up a github repo of some "mock" api source code.

So now the site http://rubydoc.info/ (a YARD documentation server) automatically creates (and hosts) the api documentation directly from the github repo.

If interested in writing docu, you have a couple options:

I could add people as collaborators to the project, in which case you would be able to edit and push changes directly using git, or
You can just clone, edit, and then make pull requests; in which I would need to decide to accept the edits and merge them into the main repo.

Let me know what you think, and if you're interested in being a collaborator.

thomthom

Sounds interesting. Sign me up.

Jim

@thomthom said:

Sounds interesting. Sign me up.

You should be able to push directly, thanks.

Jim

I have the basic hierarchy set up for the classes and modules. It's nice to be able to see all of a classes methods and inherited methods on a single page ; for example Sketchup::Edge.

The next most important work is to add @return tags to as many methods as possible in order to enable linking the return values to the documentation for the returned type.

For example, the following would enable linking back to the Array class in the documentation, which is handy when following the method lookup chain of SketchUp objects.

module Sketchup
  class Edge
    # @return [Array] an array of connected entities plus the edge itself.
    def all_connected
    end
  end
end

See the yard guide for more info.

Dan Rathbun

Looks nice so far !

jolran

Yeah, this looks really great. Thanks for doing this!

Jim

@dan rathbun said:

Looks nice so far !

@jolran said:

Yeah, this looks really great. Thanks for doing this!

Thanks.

Did you know you can do online edits right on github? Should I sign you up?

thomthom

I really want to add info to UI::WebDialog and Geom::PolygonMesh which is areas where the official docs are lacking and/or often plain wrong! I got a bit much on my plate right now, but I'll get around to it.

jolran

@unknownuser said:

Did you know you can do online edits right on github? Should I sign you up?

I'm afraid of messing things up

I mean, maybe it's best if these things are done by proffessionals.

Chris Fullmer

I feel the same.

But Github has version history, so if you mess something up, one of the professionals sxhould be able to undo your changes if I recall correctly.

I'm hoping maybe this will be a good chance for me to learn how to work on one of these collaborative projects. I never really got into it that last time (skx, etc).

thomthom

Go for it!
These docs can easily become better than the official.

Dan Rathbun

Bookmark these links:

YARD Features

YARD Tags

bigcatln

Sounds a good idea,support!

Jim

Added some new methods that came in version 8.0 M2. https://github.com/jimfoltz/SketchUp-Ruby-API-Doc

The new GitHub Windows client makes it very easy to contribute.