XcodePages 0.0.5 → 0.0.6

data/README.rdoc

@@ -61,6 +61,19 @@ settings provided therein *override* XcodePages defaults. This may include the
 default. You need to comment out or delete the setting to allow XcodePages to
 auto-generate the appropriate default.
 
+==== When Pushing to GitHub Pages
+
+When your project uses GitHub for version control, you can conveniently publish
+the HTML documentation pages by pushing the HTML to branch +gh-pages+. However,
+is a caveat when doing this.
+
+You will need to touch and commit +.nojekyll+ in the root of your branch.
+Otherwise, the Doxygen pages will not appear. GitHub uses {Jekyll, a blog-aware
+static site generator}[https://github.com/mojombo/jekyll] that monkeys around
+with underscores within paths. Unfortunately, Doxygen uses underscore in path
+names as delimiters, by default. You can switch this off with +.nojekyll+ or
+tell Doxygen to use short names using +SHORT_NAMES = YES+ in your +Doxyfile+.
+
 === Step 4
 
 You can now switch target to +MyProjectPages+ and hit Build (Cmd+B) to compile
@@ -75,6 +88,13 @@ set.
 == Benefits
 
 * Takes the "fiddle" out of fiddling with Doxygen.
+
+  There is naturally more documentation, and better too, when generating the
+  documentation is _easy_. Would it not be easy if you could just type some
+  Doxygen comment blocks in Xcode, press Cmd+B to build the documentation and
+  then immediately read it within Xcode's documentation? Try out
+  XcodePages[http://rubydoc.info/gems/XcodePages]! It _is_ that easy.
+
 * You can easily identify undocumented classes and methods.
 
   Warning messages output by Doxygen make this possible. After building your
@@ -82,6 +102,10 @@ set.
   elements within your project. Press the Cmd+\' (Jump to Next Issue command) to
   navigate through the undocumented code.
 
+  Note, however, that you may still need to reload (or even restart Xcode) if
+  your major documentation sections change. Xcode document viewer appears to
+  cache them.
+
 == Examples
 
 You can find examples of projects using XcodePages here:

data/lib/XcodePages/version.rb

@@ -1,3 +1,3 @@
 module XcodePages
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/XcodePages.rb

@@ -104,7 +104,6 @@ module XcodePages
         SOURCE_BROWSER         = YES
         HTML_TIMESTAMP         = NO
         GENERATE_LATEX         = NO
-        HAVE_DOT               = YES
       EOF
 
       # Let the user override the previous defaults by loading up the Doxyfile

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: XcodePages
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-23 00:00:00.000000000 Z
+date: 2011-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70133083833920 !ruby/object:Gem::Requirement
+  requirement: &70105779299960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133083833920
+  version_requirements: *70105779299960
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70133100116420 !ruby/object:Gem::Requirement
+  requirement: &70105779299540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70133100116420
+  version_requirements: *70105779299540
 description: ! "\n    Helps you publish HTML web pages on the Internet somewhere appropriate,
   e.g.\n    on GitHub via the gh-pages branch feature.\n\n    Works for Objective-C
   projects built using Apple's Xcode IDE and\n    consequently focuses on documentation