Skip to content

Commit

Permalink
[docs] Language consistency. Aggressive tidying of the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
jverkoey committed Jun 18, 2012
1 parent 127e1c7 commit 6f48a37
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 8 deletions.
5 changes: 3 additions & 2 deletions docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ PROJECT_NUMBER = 0.9.3
# for a project that appears at the top of each page and should give viewer
# a quick idea about the purpose of the project. Keep the description short.

PROJECT_BRIEF = "An iOS framework whose growth is bounded by O(documentation)."
PROJECT_BRIEF = "The iOS framework whose growth is bounded by its documentation."

# With the PROJECT_LOGO tag one can specify an logo or icon that is
# included in the documentation. The maximum height of the logo should not
Expand Down Expand Up @@ -898,7 +898,8 @@ HTML_STYLESHEET = docs/stylesheet.css
# the files will be copied as-is; there are no commands or markers available.

HTML_EXTRA_FILES = docs/fixed.js \
docs/cleannavtree.js
docs/cleannavtree.js \
docs/gfx/nimbus128.png

# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
# Doxygen will adjust the colors in the stylesheet and background images
Expand Down
2 changes: 1 addition & 1 deletion docs/Doxyfile-docset
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ PROJECT_NUMBER = 0.9.3
# for a project that appears at the top of each page and should give viewer
# a quick idea about the purpose of the project. Keep the description short.

PROJECT_BRIEF = "An iOS framework whose growth is bounded by O(documentation)."
PROJECT_BRIEF = "The iOS framework whose growth is bounded by its documentation."

# With the PROJECT_LOGO tag one can specify an logo or icon that is
# included in the documentation. The maximum height of the logo should not
Expand Down
12 changes: 11 additions & 1 deletion docs/cleannavtree.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,14 @@ for (var i = 0; i < NAVTREE[0][2].length; ++i) {
if (name.indexOf('Nimbus ') == 0) {
NAVTREE[0][2][i][0] = name.substr('Nimbus '.length);
}
}
}

function addAnchors(){
$.each($('.groupHeader'),function(index, value){
var identifier = $(this).text().toLowerCase().replace(/ /g, '-').replace(/[^a-zA-Z0-9 \-]/g, '');
$('#box-anchors').append('<li><a href="#anchor-'+index+'">'+$(this).html()+'</a></li>');
$(this).prepend('<a name="'+identifier+'"></a>');
});
}

$(document).ready(addAnchors);
Binary file added docs/gfx/nimbus128.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion docs/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@
<img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">
</form>
<a href="http://nimbuskit.info/donations">Why donate?</a>
</div>
</div>
<a href="index.html"><img style="float:left" src="nimbus128.png" width="80" height="80" /></a>
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
Expand Down
16 changes: 13 additions & 3 deletions src/Doxygen.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,19 @@
*
* Nimbus is an iOS framework whose feature set grows only as fast as its documentation.
*
* By focusing on documentation first and features second, Nimbus hopes to be a framework
* that accelerates the development process of any application by being easy to use and simple
* to understand.
* By focusing on documentation first and features second, Nimbus accelerates the development
* process of any application while being easy to use and simple to understand.
*
* <h2>Navigating the Documentation</h2>
*
* There are two primary forms of documentation for Nimbus: autogenerated documentation and
* community documentation. You are currently reading the autogenerated documentation, which has
* been generated from the Nimbus source code and focuses on individual Nimbus features.
*
* The community documentation is available via the
* <a href="http://wiki.nimbuskit.info/">Nimbus Wiki</a> and contains articles relevant to broader
* topics such as installing Xcode docsets and best practices. The community wiki is editable by
* anyone with a Github account.
*
* <h2>Getting Started</h2>
*
Expand Down

0 comments on commit 6f48a37

Please sign in to comment.