Document Pages, Misc, and Content Models

azenla · azenla · commit e18c94e15d53 · 2014-08-22T21:38:17.000-04:00
diff --git a/lib/src/client/contents.dart b/lib/src/client/contents.dart
@@ -6,33 +6,63 @@ part of github.client;
 class File {
   final GitHub github;
 
+  /**
+   * Type of File
+   */
   @ApiName("type")
   String type;
 
+  /**
+   * File Encoding
+   */
   @ApiName("encoding")
   String encoding;
 
+  /**
+   * File Size
+   */
   @ApiName("size")
   int size;
 
+  /**
+   * File Name
+   */
   @ApiName("name")
   String name;
 
+  /**
+   * File Path
+   */
   @ApiName("path")
   String path;
 
+  /**
+   * File Content
+   */
   @ApiName("content")
   String content;
 
+  /**
+   * SHA
+   */
   @ApiName("sha")
   String sha;
 
+  /**
+   * Url to file
+   */
   @ApiName("html_url")
   String url;
 
+  /**
+   * Git Url
+   */
   @ApiName("git_url")
   String gitUrl;
 
+  /**
+   * Links
+   */
   @ApiName("_links")
   FileLinks links;
 
@@ -55,13 +85,25 @@ class File {
   }
 }
 
+/**
+ * File Links
+ */
 class FileLinks {
+  /**
+   * Git Link
+   */
   @ApiName("git")
   String git;
 
+  /**
+   * Self Link
+   */
   @ApiName("self")
   String self;
 
+  /**
+   * HTML Link
+   */
   @ApiName("html")
   String html;
 
diff --git a/lib/src/client/misc.dart b/lib/src/client/misc.dart
@@ -1,8 +1,19 @@
 part of github.client;
 
+/**
+ * A Gitignore Template
+ */
 class GitignoreTemplate {
   final GitHub github;
+  
+  /**
+   * Template Name
+   */
   String name;
+  
+  /**
+   * Template Source
+   */
   String source;
   
   GitignoreTemplate(this.github);
diff --git a/lib/src/client/pages.dart b/lib/src/client/pages.dart
@@ -1,11 +1,24 @@
 part of github.client;
 
+/**
+ * GitHub Pages Information
+ */
 class RepositoryPages {
   final GitHub github;
   
+  /**
+   * Pages CNAME
+   */
   String cname;
+  
+  /**
+   * Pages Status
+   */
   String status;
   
+  /**
+   * If the repo has a custom 404
+   */
   @ApiName("custom_404")
   bool custom404;
   
