Skip to content
Help Document the SketchUp Ruby API using Yard
Ruby HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
generated
lib
.gitignore
.yardopts
Constants.md
RenderingOptions.md
Yard API.html
readme.md

readme.md

Update: 2016-10-03 - The official SketchUp documentation is now updated and using a similar idea. Visit the official SketchUp Ruby API Documentation.

This is a project to document the SketchUp Ruby API using YARD the Ruby documentation tool.

Although the official SketchUp Ruby API documentation is very good, it does have some problems.

Lack of navigation between classes was a major feature missing although that has been recently address to some extent.

The other major problem is accuracy. Many method parameters and return values are omitted, others are just wrong. Many of the code examples are poor or incorrect.

Contributions of code or otherwise are happily accepted. If you aren't into writing yard docs, you can still file issues to report problems or discuss the documentation.

The github page: https://github.com/jimfoltz/SketchUp-Ruby-API-Doc

The generated documentation is available online at RubyDoc.info

2015-01-08 JF

You can’t perform that action at this time.