yard-sketchup 1.1.4 → 1.1.5

data/lib/yard-sketchup/templates/default/fulldoc/html/setup.rb

@@ -1,66 +1,66 @@
-# Helpers:
-
-# Copy verbatim an asset file to the target output. By default it uses the
-# same relative path as the source for the target path.
-def copy(source, target = nil)
-  path = self.class.find_file(source)
-  # puts "copy(#{source}, #{target})"
-  # puts "> path: #{path}"
-  raise ArgumentError, "no file for '#{source}' in #{self.class.path}" unless path
-  target ||= source
-  asset(target, File.binread(path))
-end
-
-# Template overrides:
-
-def javascripts_full_list
-  %w(js/jquery.js js/full_list.js js/sketchup.js)
-end
-
-def generate_assets
-  super
-  copy('favicon.ico')
-  copy('images/SU_Developer-RedWhite.png')
-  copy('images/trimble-logo-white.png')
-end
-
-# Custom search list grouping the classes in the API into similar groups.
-# TODO(thomthom): This file is just a stub.
-
-def generate_object_types_list
-   #@items = options.objects if options.objects
-   @items = [
-      "App Level Classes",
-      "Entity Classes",
-      "Collection Classes",
-      "Geom Classes",
-      "UI Classes",
-      "Observer Classes",
-      "Core Ruby Classes"
-   ]
-   @list_title = "Object Index"
-   @list_type = "object_types"
-
-   # optional: the specified stylesheet class
-   # when not specified it will default to the value of @list_type
-   @list_class = "class"
-
-   # Generate the full list html file with named feature_list.html
-   # @note this file must be match the name of the type
-   asset(url_for_list(@list_type), erb(:full_list))
-end
-
-
-# See `class_list` in fulldoc/html.
-def reference_list
-   even_odd = "odd"
-   out = ""
-   @items.each { |item|
-      out << "<li class='#{even_odd}'>"
-      out << "<a class='toggle'></a>"
-      out << item
-      out << "</li>"
-      even_odd = (even_odd == 'even' ? 'odd' : 'even')
-   }
-   out
-end
+# Helpers:
+
+# Copy verbatim an asset file to the target output. By default it uses the
+# same relative path as the source for the target path.
+def copy(source, target = nil)
+  path = self.class.find_file(source)
+  # puts "copy(#{source}, #{target})"
+  # puts "> path: #{path}"
+  raise ArgumentError, "no file for '#{source}' in #{self.class.path}" unless path
+  target ||= source
+  asset(target, File.binread(path))
+end
+
+# Template overrides:
+
+def javascripts_full_list
+  %w(js/jquery.js js/full_list.js js/sketchup.js)
+end
+
+def generate_assets
+  super
+  copy('favicon.ico')
+  copy('images/SU_Developer-RedWhite.png')
+  copy('images/trimble-logo-white.png')
+end
+
+# Custom search list grouping the classes in the API into similar groups.
+# TODO(thomthom): This file is just a stub.
+
+def generate_object_types_list
+   #@items = options.objects if options.objects
+   @items = [
+      "App Level Classes",
+      "Entity Classes",
+      "Collection Classes",
+      "Geom Classes",
+      "UI Classes",
+      "Observer Classes",
+      "Core Ruby Classes"
+   ]
+   @list_title = "Object Index"
+   @list_type = "object_types"
+
+   # optional: the specified stylesheet class
+   # when not specified it will default to the value of @list_type
+   @list_class = "class"
+
+   # Generate the full list html file with named feature_list.html
+   # @note this file must be match the name of the type
+   asset(url_for_list(@list_type), erb(:full_list))
+end
+
+
+# See `class_list` in fulldoc/html.
+def reference_list
+   even_odd = "odd"
+   out = ""
+   @items.each { |item|
+      out << "<li class='#{even_odd}'>"
+      out << "<a class='toggle'></a>"
+      out << item
+      out << "</li>"
+      even_odd = (even_odd == 'even' ? 'odd' : 'even')
+   }
+   out
+end

data/lib/yard-sketchup/templates/default/layout/html/embed_meta.erb

@@ -1,78 +1,78 @@
-<%  su_site_name = h options.title
-    case object
-    when String
-      if object == "_index.html" || object == "index.html"
-        su_page_url = "https://ruby.sketchup.com/index.html"
-        su_page_title = "Alphabetic Index"
-        su_page_desc  = "Alphabetic Index of Files and API Namespaces. This is the main landing page for the SketchUp Ruby API Documentation."
-      else
-        su_page_url = "https://ruby.sketchup.com/"+(object =~ /(.html)\z/ ? object : "#{File.basename(object,'.*')}.html" )
-        su_page_title = (@page_title && !@page_title.empty?) ? (h @page_title) : object.split('.')[0]
-        su_page_desc  = "The #{su_page_title} page."
-      end
-    when YARD::CodeObjects::Base # or subclass
-      if object.root?
-        if @file # Generating a YARD::CodeObjects::ExtraFileObject
-          su_page_url   = "https://ruby.sketchup.com/file.#{File.basename(@file.filename,'.*')}.html"
-          su_page_title = h @page_title
-          su_page_desc  = @file.title
-        elsif h @page_title == "Top Level Namespace"
-          su_page_url   = "https://ruby.sketchup.com/top-level-namespace.html"
-          su_page_title = h @page_title
-          su_page_desc  = "The Top Level Namespace for Ruby and the SketchUp API, listing global constants, and a summary of toplevel modules and classes."
-        else %>
-      <!-- <%= "YARD Error - (embed_meta.erb) Unknown root object - using site name." %>--><%
-          su_page_title = su_site_name
-          su_page_url   = "https://ruby.sketchup.com/"
-          su_page_desc  = "#{su_site_name}."
-        end
-      else # Generating a Class or Module page:
-        su_page_url   = "https://ruby.sketchup.com/#{@path.gsub('::','/')}.html"
-        su_page_title = h @page_title
-        if object.docstring.blank?
-          if object.is_a?(YARD::CodeObjects::ClassObject)
-            su_page_desc = "The #{@path} class."
-          elsif object.is_a?(YARD::CodeObjects::ModuleObject)
-            su_page_desc = "The #{@path} module."
-          else
-            su_page_desc = "The #{su_page_title} page."
-          end %>
-      <!-- <%= "YARD Warning - Blank docstring, object is: #{object.class.name}" %>--><%
-        else
-          su_page_desc = object.docstring.summary.gsub(/[{}+]/,'')
-        end
-      end # if root object
-    else # object is unexpected type %>
-      <!-- <%= "YARD Error - (embed_meta.erb) Unexpected type: #{object.class.name}" %>--><%
-      su_page_title = su_site_name
-      su_page_url   = "https://ruby.sketchup.com/"
-      if object.respond_to?(:docstring)
-        su_page_desc = object.docstring.summary.gsub(/[{}+]/,'')
-      else
-        su_page_desc  = "#{su_site_name}."
-      end
-    end
-    su_page_img = "http://developer.sketchup.com/sites/developers.sketchup.com/files/Ruby.svg"
-%>
-  <!-- GENERIC META PROPERTIES -->
-    <meta name="url"   content="<%= su_page_url %>" />
-    <meta name="image" content="<%= su_page_img %>?s=60" />
-    <meta name="title" content="<%= su_page_title %>" />
-    <meta name="name"  content="<%= su_site_name %>" />
-    <meta name="description" content="<%= su_page_desc %>" />
-  <!-- OPEN GRAPH META PROPERTIES -->
-    <meta property="og:site_name" content="<%= su_site_name %>" />
-    <meta property="og:type"      content="website" />
-    <meta property="og:image"     content="<%= su_page_img %>" />
-    <meta property="og:image:width"  content="60" />
-    <meta property="og:image:height" content="60" />
-    <meta property="og:title"     content="<%= su_page_title %>" />
-    <meta property="og:url"       content="<%= su_page_url %>" />
-    <meta property="og:description" content="<%= su_page_desc %>" />
-  <!-- TWITTER CARD META PROPERTIES -->
-    <meta name="twitter:card"  content="summary"   />
-    <meta name="twitter:site"  content="@sketchup" />
-    <meta name="twitter:title" content="<%= su_page_title %>" />
-    <meta name="twitter:description" content="<%= su_page_desc %>" />
-    <meta name="twitter:image:src"   content="<%= su_page_img %>?s=120" />
-    <meta name="twitter:url"   content="<%= su_page_url %>" />
+<%  su_site_name = h options.title
+    case object
+    when String
+      if object == "_index.html" || object == "index.html"
+        su_page_url = "https://ruby.sketchup.com/index.html"
+        su_page_title = "Alphabetic Index"
+        su_page_desc  = "Alphabetic Index of Files and API Namespaces. This is the main landing page for the SketchUp Ruby API Documentation."
+      else
+        su_page_url = "https://ruby.sketchup.com/"+(object =~ /(.html)\z/ ? object : "#{File.basename(object,'.*')}.html" )
+        su_page_title = (@page_title && !@page_title.empty?) ? (h @page_title) : object.split('.')[0]
+        su_page_desc  = "The #{su_page_title} page."
+      end
+    when YARD::CodeObjects::Base # or subclass
+      if object.root?
+        if @file # Generating a YARD::CodeObjects::ExtraFileObject
+          su_page_url   = "https://ruby.sketchup.com/file.#{File.basename(@file.filename,'.*')}.html"
+          su_page_title = h @page_title
+          su_page_desc  = @file.title
+        elsif h @page_title == "Top Level Namespace"
+          su_page_url   = "https://ruby.sketchup.com/top-level-namespace.html"
+          su_page_title = h @page_title
+          su_page_desc  = "The Top Level Namespace for Ruby and the SketchUp API, listing global constants, and a summary of toplevel modules and classes."
+        else %>
+      <!-- <%= "YARD Error - (embed_meta.erb) Unknown root object - using site name." %>--><%
+          su_page_title = su_site_name
+          su_page_url   = "https://ruby.sketchup.com/"
+          su_page_desc  = "#{su_site_name}."
+        end
+      else # Generating a Class or Module page:
+        su_page_url   = "https://ruby.sketchup.com/#{@path.gsub('::','/')}.html"
+        su_page_title = h @page_title
+        if object.docstring.blank?
+          if object.is_a?(YARD::CodeObjects::ClassObject)
+            su_page_desc = "The #{@path} class."
+          elsif object.is_a?(YARD::CodeObjects::ModuleObject)
+            su_page_desc = "The #{@path} module."
+          else
+            su_page_desc = "The #{su_page_title} page."
+          end %>
+      <!-- <%= "YARD Warning - Blank docstring, object is: #{object.class.name}" %>--><%
+        else
+          su_page_desc = object.docstring.summary.gsub(/[{}+]/,'')
+        end
+      end # if root object
+    else # object is unexpected type %>
+      <!-- <%= "YARD Error - (embed_meta.erb) Unexpected type: #{object.class.name}" %>--><%
+      su_page_title = su_site_name
+      su_page_url   = "https://ruby.sketchup.com/"
+      if object.respond_to?(:docstring)
+        su_page_desc = object.docstring.summary.gsub(/[{}+]/,'')
+      else
+        su_page_desc  = "#{su_site_name}."
+      end
+    end
+    su_page_img = "http://developer.sketchup.com/sites/developers.sketchup.com/files/Ruby.svg"
+%>
+  <!-- GENERIC META PROPERTIES -->
+    <meta name="url"   content="<%= su_page_url %>" />
+    <meta name="image" content="<%= su_page_img %>?s=60" />
+    <meta name="title" content="<%= su_page_title %>" />
+    <meta name="name"  content="<%= su_site_name %>" />
+    <meta name="description" content="<%= su_page_desc %>" />
+  <!-- OPEN GRAPH META PROPERTIES -->
+    <meta property="og:site_name" content="<%= su_site_name %>" />
+    <meta property="og:type"      content="website" />
+    <meta property="og:image"     content="<%= su_page_img %>" />
+    <meta property="og:image:width"  content="60" />
+    <meta property="og:image:height" content="60" />
+    <meta property="og:title"     content="<%= su_page_title %>" />
+    <meta property="og:url"       content="<%= su_page_url %>" />
+    <meta property="og:description" content="<%= su_page_desc %>" />
+  <!-- TWITTER CARD META PROPERTIES -->
+    <meta name="twitter:card"  content="summary"   />
+    <meta name="twitter:site"  content="@sketchup" />
+    <meta name="twitter:title" content="<%= su_page_title %>" />
+    <meta name="twitter:description" content="<%= su_page_desc %>" />
+    <meta name="twitter:image:src"   content="<%= su_page_img %>?s=120" />
+    <meta name="twitter:url"   content="<%= su_page_url %>" />

data/lib/yard-sketchup/templates/default/layout/html/footer.erb

@@ -1,4 +1,4 @@
-<div id="footer">
-  Generated by
-  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-</div>
+<div id="footer">
+  Generated by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+</div>

data/lib/yard-sketchup/templates/default/layout/html/headers.erb

@@ -1,15 +1,15 @@
-  <meta charset="<%= charset %>">
-  <!-- VIEWPORT -->
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <!-- AUTHOR and GENERATOR -->
-    <meta name="author" content="SketchUp Extensibility Team">
-    <meta name="generator" content="YARD https://yardoc.org">
-  <!-- TITLE -->
-    <title><% if object == "_index.html" || object == "index.html" %>
-    Alphabetic Index &mdash; <%= h options.title %><% else %>
-    <%= h @page_title %><% if options.title && @page_title != options.title %> &mdash; <%= h options.title %><% end %><% end %>
-    </title>
-  <!-- SHORTCUT ICON -->
-    <link rel="shortcut icon" type="image/vnd.microsoft.icon"
-    href="https://ruby.sketchup.com/favicon.ico" />
-<%= erb(:embed_meta) %>
+  <meta charset="<%= charset %>">
+  <!-- VIEWPORT -->
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <!-- AUTHOR and GENERATOR -->
+    <meta name="author" content="SketchUp Extensibility Team">
+    <meta name="generator" content="YARD https://yardoc.org">
+  <!-- TITLE -->
+    <title><% if object == "_index.html" || object == "index.html" %>
+    Alphabetic Index &mdash; <%= h options.title %><% else %>
+    <%= h @page_title %><% if options.title && @page_title != options.title %> &mdash; <%= h options.title %><% end %><% end %>
+    </title>
+  <!-- SHORTCUT ICON -->
+    <link rel="shortcut icon" type="image/vnd.microsoft.icon"
+    href="https://ruby.sketchup.com/favicon.ico" />
+<%= erb(:embed_meta) %>

data/lib/yard-sketchup/templates/default/layout/html/layout.erb

@@ -1,55 +1,55 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <%= erb(:headers) %>
-  <!-- STYLESHEETS -->
-    <link rel="stylesheet" type="text/css"
-      href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic" />
-<% stylesheets.each do |stylesheet| %>
-    <link rel="stylesheet" href="<%= url_for(stylesheet) %>" type="text/css" charset="utf-8" />
-<% end %>
-  <!-- SCRIPTS -->
-<%= erb :script_setup %>
-<% javascripts.each do |javascript| %>
-    <script type="text/javascript" charset="utf-8" src="<%= url_for(javascript) %>"></script>
-<% end %>
-    <script>
-      // Every time this page is loaded, it sends this action to SketchUp, telling
-      // SketchUp that a new page has loaded that has example snippets that should
-      // be replaced with code editors. Nothing happens if the page is loaded in a
-      // regular browser outside of the SketchUp client.
-      $( document ).ready(function() {
-        if (typeof sketchup == 'object') {
-          sketchup.page_loaded();
-        }
-      });
-    </script>
-
-</head>
-<body>
-
-  <%= erb(:navbar) %>
-
-  <div id="su-content">
-
-    <div class="nav_wrap">
-      <iframe id="nav" src="<%= @nav_url %>"></iframe>
-      <div id="resizer"></div>
-    </div>
-
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <%= erb(:breadcrumb) %>
-        <%= erb(:search) %>
-        <div class="clear"></div>
-      </div>
-
-      <div id="content"><%= yieldall %></div>
-
-      <%= erb(:footer) %>
-    </div>
-
-  </div>
-
-</body>
-</html>
+<!DOCTYPE html>
+<html>
+<head>
+  <%= erb(:headers) %>
+  <!-- STYLESHEETS -->
+    <link rel="stylesheet" type="text/css"
+      href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic" />
+<% stylesheets.each do |stylesheet| %>
+    <link rel="stylesheet" href="<%= url_for(stylesheet) %>" type="text/css" charset="utf-8" />
+<% end %>
+  <!-- SCRIPTS -->
+<%= erb :script_setup %>
+<% javascripts.each do |javascript| %>
+    <script type="text/javascript" charset="utf-8" src="<%= url_for(javascript) %>"></script>
+<% end %>
+    <script>
+      // Every time this page is loaded, it sends this action to SketchUp, telling
+      // SketchUp that a new page has loaded that has example snippets that should
+      // be replaced with code editors. Nothing happens if the page is loaded in a
+      // regular browser outside of the SketchUp client.
+      $( document ).ready(function() {
+        if (typeof sketchup == 'object') {
+          sketchup.page_loaded();
+        }
+      });
+    </script>
+
+</head>
+<body>
+
+  <%= erb(:navbar) %>
+
+  <div id="su-content">
+
+    <div class="nav_wrap">
+      <iframe id="nav" src="<%= @nav_url %>"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <%= erb(:breadcrumb) %>
+        <%= erb(:search) %>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><%= yieldall %></div>
+
+      <%= erb(:footer) %>
+    </div>
+
+  </div>
+
+</body>
+</html>

data/lib/yard-sketchup/templates/default/layout/html/navbar.erb

@@ -1,36 +1,36 @@
-<!-- SU - start -->
-<header id="navbar" role="banner" class="navbar navbar-fixed-top navbar-inverse">
-    <div id="api-documentation-header">
-        <div class="navbar-header">
-            <a class="logo navbar-btn pull-left" href="https://developer.sketchup.com" title="Home">
-                <img src="https://ruby.sketchup.com/images/SU_Developer-RedWhite.png" alt="Home">
-            </a>
-            <a class="name navbar-brand" href="/en" title="Home">SketchUp Developer Center</a>
-            <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
-            <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
-                <span class="sr-only">Toggle navigation</span>
-                <span class="icon-bar"></span>
-                <span class="icon-bar"></span>
-                <span class="icon-bar"></span>
-            </button>
-        </div>
-        <div class="navbar-collapse collapse">
-            <nav role="navigation">
-                <ul class="menu nav navbar-nav">
-                    <li class="first leaf"><a href="https://forums.sketchup.com/c/developers">Community</a></li>
-                    <li class="leaf"><a href="https://blog.sketchup.com/">SketchUp Blog</a></li>
-                    <li class="leaf"><a href="https://www.sketchup.com/download" class="top-menu--download-button">Download</a></li>
-                    <li class="last expanded dropdown">
-                        <a href="https://www.trimble.com" class="trimble-top-menu-item dropdown-toggle" data-target="#" data-toggle="dropdown"><img src="https://ruby.sketchup.com/images/trimble-logo-white.png"><span class="caret"></span></a>
-                        <ul class="dropdown-menu">
-                            <li class="first leaf"><a href="https://connect.trimble.com/">Trimble Connect</a></li>
-                            <li class="leaf"><a href="https://www.trimble.com/Corporate/About_Trimble.aspx">About Trimble</a></li>
-                            <li class="last leaf"><a href="https://buildings.trimble.com/">Trimble Buildings</a></li>
-                        </ul>
-                    </li>
-                </ul>
-            </nav>
-        </div>
-    </div>
-</header>
-<!-- SU - end -->
+<!-- SU - start -->
+<header id="navbar" role="banner" class="navbar navbar-fixed-top navbar-inverse">
+    <div id="api-documentation-header">
+        <div class="navbar-header">
+            <a class="logo navbar-btn pull-left" href="https://developer.sketchup.com" title="Home">
+                <img src="https://ruby.sketchup.com/images/SU_Developer-RedWhite.png" alt="Home">
+            </a>
+            <a class="name navbar-brand" href="/en" title="Home">SketchUp Developer Center</a>
+            <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
+            <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+                <span class="sr-only">Toggle navigation</span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+            </button>
+        </div>
+        <div class="navbar-collapse collapse">
+            <nav role="navigation">
+                <ul class="menu nav navbar-nav">
+                    <li class="first leaf"><a href="https://forums.sketchup.com/c/developers">Community</a></li>
+                    <li class="leaf"><a href="https://blog.sketchup.com/">SketchUp Blog</a></li>
+                    <li class="leaf"><a href="https://www.sketchup.com/download" class="top-menu--download-button">Download</a></li>
+                    <li class="last expanded dropdown">
+                        <a href="https://www.trimble.com" class="trimble-top-menu-item dropdown-toggle" data-target="#" data-toggle="dropdown"><img src="https://ruby.sketchup.com/images/trimble-logo-white.png"><span class="caret"></span></a>
+                        <ul class="dropdown-menu">
+                            <li class="first leaf"><a href="https://connect.trimble.com/">Trimble Connect</a></li>
+                            <li class="leaf"><a href="https://www.trimble.com/Corporate/About_Trimble.aspx">About Trimble</a></li>
+                            <li class="last leaf"><a href="https://buildings.trimble.com/">Trimble Buildings</a></li>
+                        </ul>
+                    </li>
+                </ul>
+            </nav>
+        </div>
+    </div>
+</header>
+<!-- SU - end -->