Merge lp:~uriboni/qt-halide/documentation into lp:qt-halide

[Ugo Riboni]

Add documentation.

Use make docs to generate.

[lp:~uriboni/qt-halide/documentation]

311. By Ugo Riboni on 2015-04-08

Document the rest of the classes accessible from QML

312. By Ugo Riboni on 2015-04-08

Merge changes from trunk

313. By Ugo Riboni on 2015-04-08

Remove debug flag from qdoc invocation

314. By Ugo Riboni on 2015-04-09

Remove some unnecessary code blocks

[Florian Boucault (fboucault)]

"Import Statement: import QtHalide ."

are missing the versions

review: Needs Fixing

[Florian Boucault (fboucault)]

HalideFunction.enabled is said to be a string when it really is a bool

review: Needs Fixing

[Florian Boucault (fboucault)]

HalideFunctionListModel: only one append() method is part of the public QML API, only that one should show up in the documentatation.

review: Needs Fixing

[Florian Boucault (fboucault)]

HalideTransform.functions is said to be of type HalideFunctionsListModel but that type does not exist. HalideFunctionListModel exists

review: Needs Fixing

[Florian Boucault (fboucault)]

HalideTransform has no example. In fact its example seems to be in HalideFunction for some reason.

review: Needs Fixing

[Florian Boucault (fboucault)]

HalideImage and HalideImageRenderer have no examples

review: Needs Fixing

[Florian Boucault (fboucault)]

HalideImageRenderer, wrong types for:

horizontalAlignment : FillMode
verticalAlignment : FillMode

review: Needs Fixing

[lp:~uriboni/qt-halide/documentation]

315. By Ugo Riboni on 2015-04-09

Fix documentation and add examples

[Ugo Riboni (uriboni)]

> HalideImage and HalideImageRenderer have no examples

Addressed all concerns except for HalideImage examples, of which there are various in other documentation files now, so I just redirect the reader there.

[Florian Boucault (fboucault)]

> "Import Statement: import QtHalide ."
>
> are missing the versions

That was not fixed.
Also the html pages have in their title "QtHalide 1.1"

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2015-04-06 16:12:13 +0000
+++ CMakeLists.txt	2015-04-09 21:30:48 +0000
@@ -66,6 +66,7 @@
 add_subdirectory(src)
 add_subdirectory(tests)
 add_subdirectory(examples)
+add_subdirectory(documentation)
 
 set(make_check_depends qthalide-qml QtHalideTestHelper)
 if(NOT ${CMAKE_CURRENT_BINARY_DIR} STREQUAL ${CMAKE_CURRENT_SOURCE_DIR})

=== added directory 'documentation'
=== added file 'documentation/CMakeLists.txt'
--- documentation/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ documentation/CMakeLists.txt	2015-04-09 21:30:48 +0000
@@ -0,0 +1,9 @@
+add_custom_target("docs"
+                  COMMAND /usr/bin/qdoc --outputdir ${CMAKE_CURRENT_BINARY_DIR} qt-halide.qdocconf
+                  WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
+
+file(GLOB QT_HALIDE_DOC_WEB_FILES css/*.css)
+file(GLOB QT_HALIDE_DOC_CONF_FILES *.qdocconf)
+
+# Make the documentation files visible in qtcreator
+add_custom_target(qthalide_docs_config ALL SOURCES ${QT_HALIDE_DOC_CONF_FILES} ${QT_HALIDE_DOC_WEB_FILES})

=== added directory 'documentation/css'
=== added file 'documentation/css/base.css'
--- documentation/css/base.css	1970-01-01 00:00:00 +0000
+++ documentation/css/base.css	2015-04-09 21:30:48 +0000
@@ -0,0 +1,638 @@
+/**
+* Ubuntu Developer base stylesheet
+*
+* A base stylesheet containing site-wide styles
+*
+* @project Ubuntu Developer
+* @version 1.0
+* @author Canonical Web Team: Steve Edwards
+* @copyright 2011 Canonical Ltd.
+*/
+
+/**
+* @section Global
+*/
+
+body {
+	font-family: 'Ubuntu', 'Ubuntu Beta', UbuntuBeta, Ubuntu, 'Bitstream Vera Sans', 'DejaVu Sans', Tahoma, sans-serif;
+	font-size: 13px;
+	line-height: 1.4;
+	color: #333;
+}
+a {
+	color: #dd4814;
+	text-decoration: none;
+	outline: 0;
+}
+p, dl {
+	margin-bottom: 10px;
+}
+strong {
+	font-weight: bold;
+}
+em {
+	font-style: italic;
+}
+code{
+	padding: 10px;
+	font-family: 'Ubuntu Mono', 'Consolas', 'Monaco', 'DejaVu Sans Mono', Courier, monospace;
+	background-color: #fdf6f2;
+	display: block;
+	margin-bottom: 10px;
+		-moz-border-radius: 4px;
+		-webkit-border-radius: 4px;
+	border-radius: 4px;
+}
+h1 {
+	font-size: 36px;
+	line-height: 1.1;
+	margin-bottom: 20px;
+}
+article h1,
+h2 {
+	font-size: 24px;
+	line-height: 1.2;
+	margin-bottom: 14px;
+}
+h3 {
+	font-size: 16px;
+	line-height: 1.3;
+	margin-bottom: 8px;
+}
+h4 {
+	font-weight: bold;
+}
+
+time {
+	color:#999;
+}
+
+/**
+* @section Structure
+*/
+
+.header-login,
+.header-navigation div,
+.header-content div {
+	margin: 0 auto;
+	width: 940px;
+}
+
+.header-content h1{
+	background-color:#ffffff;
+	display:inline-block;
+}
+
+.header-content h2{
+	background-color:#ffffff;
+	display:table;
+}
+
+.header-login ul {
+	margin: 4px 0;
+	float: right;
+}
+.header-login li {
+	margin-right: 10px;
+	float: left;
+}
+.header-login a {
+	color: #333;
+}
+.header-navigation {
+	border-top: 2px solid #dd4814;
+	border-bottom: 2px solid #dd4814;
+	background-color: #fff;
+	height: 54px;
+	clear: right;
+	overflow: hidden;
+}
+.header-navigation nav ul {
+	border-right: 1px solid #dd4814;
+	float: right;
+}
+.header-navigation nav li {
+	border-left: 1px solid #dd4814;
+	float: left;
+	height: 54px;
+}
+.header-navigation nav a {
+	padding: 18px 14px 0;
+	font-size: 14px;
+	display: block;
+	height: 36px;
+}
+.header-navigation nav a:hover {
+	background-color: #fcece7;
+}
+.header-navigation nav .current_page_item a,
+.header-navigation nav .current_page_parent a,
+.header-navigation nav .current_page_ancestor a {
+	background-color: #dd4814;
+	color: #fff;
+}
+.header-navigation input {
+	margin: 12px 10px 0 10px;
+	padding: 5px;
+	border-top: 1px solid #a1a1a1;
+	border-right: 1px solid #e0e0e0;
+	border-bottom: 1px solid #fff;
+	border-left: 1px solid #e0e0e0;
+	width: 90px;
+	font-style: italic;
+	color: #ccc;
+		-moz-border-radius: 3px;
+		-webkit-border-radius: 3px;
+	border-radius: 3px;
+		-moz-box-shadow: inset 0 1px 1px #e0e0e0;
+	   -webkit-box-shadow: inset 0 1px 1px #e0e0e0;
+   box-shadow: inset 0 1px 1px #e0e0e0;
+}
+.header-navigation h2 {
+	margin: 18px 0 0 6px;
+	text-transform: lowercase;
+	font-size: 22px;
+	color: #dd4814;
+	float: left;
+}
+.header-navigation .logo-ubuntu {
+	margin-top: 12px;
+	float: left;
+}
+.header-content .header-navigation-secondary {
+	margin-bottom: 40px;
+	padding: 0;
+	position: relative;
+	z-index: 2;
+}
+.header-navigation-secondary div {
+	padding: 0;
+	border: 2px solid #dd4814;
+		-moz-border-radius: 0px 0px 4px 4px;
+		-webkit-border-radius: 0px 0px 4px 4px;
+	border-radius: 0px 0px 4px 4px;
+	background: #fff;
+	border-top: 0px;
+	width: 936px;
+}
+.header-navigation-secondary nav li {
+	float: left;
+}
+.header-navigation-secondary nav li a {
+	color: #333;
+	display: block;
+	height: 25px;
+	padding: 8px 8px 0;
+}
+.header-navigation-secondary nav li:hover,
+.header-navigation-secondary nav .current_page_item a {
+	background: url("../img/sec-nav-hover.gif");
+}
+.header-content {
+	padding-bottom: 30px;
+	border-bottom: 1px solid #e0e0e0;
+		-moz-box-shadow: 0 1px 3px #e0e0e0;
+		-webkit-box-shadow: 0 1px 3px #e0e0e0;
+	box-shadow: 0 1px 3px #e0e0e0;
+	margin-bottom: 3px;
+	position: relative;
+	overflow: hidden;
+}
+footer {
+	padding: 10px 10px 40px 10px;
+	position: relative;
+		-moz-border-radius: 0 0 4px 4px;
+		-webkit-border-radius: 0 0 4px 4px;
+	border-radius: 0 0 4px 4px;
+	font-size: 12px;
+	background: url("../img/background-footer.png") repeat scroll 0 0 #f7f6f5;
+}
+footer div {
+	margin: 0 auto;
+    padding: 0 10px;
+    width: 940px;
+}
+footer a {
+	color: #000;
+}
+footer nav ul {
+	margin: 10px 17px 30px 0;
+	width: 172px;
+	display: inline-block;
+	vertical-align: top;
+	height: auto;
+	zoom: 1;
+	*display: inline;
+}
+footer nav ul.last {
+	margin-right: 0;
+}
+footer nav li {
+	margin-bottom: 8px;
+}
+footer nav li:first-child {
+	font-weight: bold;
+}
+footer p {
+	margin-bottom: 0;
+}
+#content {
+	padding-top: 35px;
+}
+.arrow-nav {
+	display: none;
+	position: absolute;
+	top: -1px;
+	z-index: 3;
+}
+.shadow {
+	margin: 30px 0 3px 0;
+	border-bottom: 1px solid #e0e0e0;
+		-moz-box-shadow: 0 2px 3px #e0e0e0;
+		-webkit-box-shadow: 0 2px 3px #e0e0e0;
+	box-shadow: 0 2px 3px #e0e0e0;
+	height: 3px;
+}
+
+/**
+* @section Site-wide
+*/
+
+#content h2{
+	font-size:24px;
+}
+
+.box-orange {
+	padding: 10px;
+	border: 3px solid #dd4814;
+		-moz-border-radius: 4px;
+		-webkit-border-radius: 4px;
+	border-radius: 4px;
+}
+.box-orange .link-action-small {
+	float: right;
+	margin: 0 0 0 20px;
+}
+.link-bug {
+	margin-left: 10px;
+	color: #999;
+}
+.link-action {
+	float: left;
+	margin-bottom: 20px;
+	padding: 8px 12px;
+	display: block;
+	background-color: #dd4814;
+	color: #fff;
+		-moz-border-radius: 20px;
+		-webkit-border-radius: 20px;
+	border-radius: 20px;
+	font-size: 16px;
+	line-height: 1.3;
+	border-top: 3px solid #e6633a;
+	border-bottom: 3px solid #c03d14;
+}
+.link-action2 {
+	float: left;
+	display: block;
+	color: #fff;
+	font-size: 16px;
+	line-height: 1.3;
+}
+.link-action2 span{
+	display:block;
+	float:left;
+}
+.link-action2 .cta-left{
+	background:url(../img/button-cta-left.png) no-repeat;
+	width:22px;
+	height:48px;
+}
+.link-action2 .cta-center{
+	background:url(../img/button-cta-slice.png) repeat-x;
+	line-height:45px;
+	height:48px;
+}
+.link-action2 .cta-right{
+	background:url(../img/button-cta-right.png) no-repeat;
+	width:22px;
+	height:48px;
+}
+
+.link-action-small {
+	float: left;
+	display: block;
+	color: #fff;
+	font-size: 16px;
+}
+.link-action-small span{
+	display:block;
+	float:left;
+	height:42px;
+}
+.link-action-small .cta-left{
+	background:url(../img/button-cta-left-small.png) no-repeat;
+	width:19px;
+}
+.link-action-small .cta-center{
+	background:url(../img/button-cta-slice-small.png) repeat-x;
+	line-height:42px;
+}
+.link-action-small .cta-right{
+	background:url(../img/button-cta-right-small.png) no-repeat;
+	width:19px;
+}
+
+.link-action:active {
+	position: relative;
+	top: 1px;
+}
+.link-action2:active {
+	position: relative;
+	top: 1px;
+}
+.link-action-small:active {
+	position: relative;
+	top: 1px;
+}
+.list-bullets li {
+	margin-bottom: 10px;
+	list-style: disc;
+	list-style-position: inside;
+}
+.box {
+	margin-bottom: 30px;
+	padding: 15px;
+	border: 1px solid #aea79f;
+		-moz-border-radius: 4px;
+		-webkit-border-radius: 4px;
+	border-radius: 4px;
+}
+.box-padded {
+	margin-bottom: 30px;
+	padding: 5px;
+	border: 2px solid #aea79f;
+		-moz-border-radius: 4px;
+		-webkit-border-radius: 4px;
+	border-radius: 4px;
+	background: url("../img/pattern-featured.gif") repeat scroll 0 0 #ebe9e7;
+	overflow: hidden;
+}
+.box-padded h3 {
+	 margin: 5px 0 10px 5px;
+}
+.box-padded div {
+	padding: 10px;
+	border: 1px solid #aea79f;
+		-moz-border-radius: 4px;
+		-webkit-border-radius: 4px;
+	border-radius: 4px;
+	background-color: #fff;
+	overflow: hidden;
+}
+.box-padded li {
+	padding: 0 10px;
+	float: left;
+	width: 211px;
+	border-right: 1px dotted #aea79f;
+}
+.box-padded li.first {
+	padding: 0;
+	margin-bottom: 0;
+}
+.box-padded li.last {
+	border: 0;
+	width: 217px;
+}
+.box-padded img {
+	margin: 0 10px 50px 0;
+	float: left;
+		-moz-border-radius: 8px;
+		-webkit-border-radius: 8px;
+	border-radius: 8px;
+}
+.box-clear {
+	margin-bottom: 40px;
+}
+.box-clear .grid-4.first {
+	margin-right: 15px;
+	padding-right: 15px;
+}
+.box-clear .grid-4 {
+	margin-left: 0;
+	margin-right: 10px;
+	padding-right: 10px;
+	width: 298px;
+}
+.box-clear time {
+	display: block;
+	border-bottom: 1px dotted #aea79f;
+	padding-bottom: 10px;
+	margin-bottom: 10px;
+}
+.box-clear div.first {
+	border-right: 1px dotted #aea79f;
+}
+.box-clear a {
+	display: block;
+}
+.box-clear .rss {
+	background: url("../img/rss.jpg") no-repeat scroll 0 center;
+	padding-left: 20px;
+}
+.box-clear .location {
+	display: block;
+	margin-bottom: 1px;
+}
+.box-clear .last {
+	margin: 0;
+	padding-right: 0;
+		-moz-border-radius: 4px;
+		-webkit-border-radius: 4px;
+	border-radius: 4px;
+	width: 293px;
+}
+
+/* Widgets */
+
+.ui-state-focus {
+	outline: none;
+}
+.ui-accordion {
+	border-bottom: 1px dotted #aea79f;
+}
+.ui-accordion a {
+	display: block;
+}
+.ui-accordion h3 {
+	margin-bottom: 0;
+	border-top: 1px dotted #aea79f;
+	position: relative;
+	font-size: 13px;
+	font-weight: bold;
+}
+.ui-accordion h3 a {
+	padding: 10px 0;
+	color: #333;
+}
+.ui-accordion h4 {
+	margin-bottom: 5px;
+}
+.ui-accordion div fieldset {
+	padding-bottom: 5px;
+}
+.ui-accordion div li,
+.ui-accordion div input {
+	margin-bottom: 10px;
+}
+.ui-accordion .ui-icon {
+	position: absolute;
+	top: 15px;
+	right: 0;
+	display: block;
+	width: 8px;
+	height: 8px;
+	background: url("../img/icon-accordion-inactive.png") 0 0 no-repeat transparent;
+}
+.ui-accordion .ui-state-active .ui-icon {
+	background-image: url("../img/icon-accordion-active.png");
+}
+.ui-accordion .current_page_item a {
+	color: #333;
+}
+.container-tweet {
+		-moz-border-radius: 4px 4px 4px 4px;
+		-webkit-border-radius: 4px 4px 4px 4px;
+	border-radius: 4px 4px 4px 4px;
+	padding: 10px 10px 10px;
+	background-color: #f7f7f7;
+}
+.container-tweet .tweet-follow {
+	margin-top: 10px;
+	margin-bottom: -10px;
+	padding-left: 55px;
+	padding-bottom: 6px;
+	background: url("../img/tweet-follow.png") 0 5px no-repeat;
+	display: block;
+}
+.container-tweet .tweet-follow span {
+	font-size: 16px;
+	font-weight: bold;
+	line-height: 1.2;
+	display: block;
+}
+.tweet a {
+	display: inline;
+}
+.tweet .tweet_text {
+	padding: 10px;
+	background-color: #fff;
+		-moz-border-radius: 4px 4px 4px 4px;
+		-webkit-border-radius: 4px 4px 4px 4px;
+	border-radius: 4px 4px 4px 4px;
+	border: 1px solid #dd4814;
+	font-size: 16px;
+	display: block;
+	clear: both;
+}
+.tweet.tweet-small .tweet_text {
+	font-size: inherit;
+}
+.tweet .tweet_text a {
+	color: #333;
+}
+.tweet .tweet_time,
+.tweet .tweet_user_and_time {
+	padding: 15px 0 10px 0;
+	position: relative;
+	top: -2px;
+	background: url("../img/tweet-arrow.png") no-repeat;
+	display: block;
+}
+.tweet .tweet_odd .tweet_time,
+.tweet .tweet_odd .tweet_user_and_time {
+	background-position: right 0;
+	float: right;
+}
+.tweet .tweet_even .tweet_time,
+.tweet .tweet_even .tweet_user_and_time {
+	background-position: left 0;
+	float: left;
+}
+
+/* Search */
+
+#content .list-search li {
+	list-style-type:none;
+	border:0px;
+	margin-bottom: 15px;
+	padding-top: 15px;
+}
+
+/* Blog */
+
+.blog-article #nav-single {
+	margin-top: 30px;
+	margin-bottom: 30px;
+}
+.blog-article #nav-single .nav-next {
+	float: right;
+}
+.blog-article article header .entry-meta {
+	margin-bottom: 20px;
+}
+.blog-article article .entry-meta {
+	color: #999;
+}
+.blog-article #respond form input[type="submit"] {
+	float: left;
+	cursor: pointer;
+	margin-bottom: 20px;
+	padding: 8px 12px;
+	display: block;
+	background-color: #dd4814;
+	color: #fff;
+		-moz-border-radius: 20px;
+		-webkit-border-radius: 20px;
+	border-radius: 20px;
+	font-size: 16px;
+	line-height: 1.3;
+	border-top: 3px solid #e6633a;
+	border-left: 3px solid #e6633a;
+	border-right: 3px solid #e6633a;
+	border-bottom: 3px solid #c03d14;
+}
+.blog-article #respond form input[type="submit"]:active {
+	position: relative;
+	top: 1px;
+}
+
+.alignnone{
+    float:left;
+    margin:10px 20px 10px 0;
+}
+.alignleft{
+    float:left;
+    margin:10px 20px 10px 0;
+}
+.alignright{
+    float:right;
+   margin:10px 0 10px 20px;
+}
+
+.aligncenter{
+	float:left;
+    margin:10px 20px 10px 0;
+}
+.entry-content h2, .entry-content h3{
+    margin-top:20px;
+}
+.entry-content ul li{
+    list-style-type: circle;
+    margin-left:16px;
+}
+
+.entry-content hr{
+	border:none;
+	border-top: 1px dotted #AEA79F;
+}

=== added file 'documentation/css/breadcrumbs.js'
--- documentation/css/breadcrumbs.js	1970-01-01 00:00:00 +0000
+++ documentation/css/breadcrumbs.js	2015-04-09 21:30:48 +0000
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+$(document).ready(function(){
+    var ul = $("ul.breadcrumb");
+    var li = ul.children("li:has(a)").remove();
+    ul.prepend(li);
+});

=== added file 'documentation/css/qtquick.css'
--- documentation/css/qtquick.css	1970-01-01 00:00:00 +0000
+++ documentation/css/qtquick.css	2015-04-09 21:30:48 +0000
@@ -0,0 +1,788 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+@media screen
+{
+
+/* basic elements */
+    html
+    {
+        color: #000000;
+        background: #FFFFFF;
+    }
+    table
+    {
+        border-collapse: collapse;
+        border-spacing: 0;
+    }
+    fieldset, img
+    {
+        border: 0;
+        max-width:100%;
+    }
+    address, caption, cite, code, dfn, em, strong, th, var, optgroup
+    {
+        font-style: inherit;
+        font-weight: inherit;
+    }
+    del, ins
+    {
+        text-decoration: none;
+    }
+    ol li
+    {
+        list-style: decimal;
+    }
+    ul li
+    {
+        list-style: none;
+    }
+    caption, th
+    {
+        text-align: left;
+    }
+    h1.title
+    {
+        font-weight: bold;
+        font-size: 150%;
+    }
+    h0
+    {
+        font-weight: bold;
+        font-size: 130%;
+    }
+    h1, h2, h3, h4, h5, h6
+    {
+        font-size: 100%;
+    }
+    q:before, q:after
+    {
+        content: '';
+    }
+    abbr, acronym
+    {
+        border: 0;
+        font-variant: normal;
+    }
+    sup, sub
+    {
+        vertical-align: baseline;
+    }
+    tt, .qmlreadonly span, .qmldefault span
+    {
+        word-spacing:0.5em;
+    }
+    legend
+    {
+        color: #000000;
+    }
+    strong
+    {
+        font-weight: bold;
+    }
+    em
+    {
+        font-style: italic;
+    }
+
+    body
+    {
+        margin: 0 1.5em 0 1.5em;
+        font-family: ubuntu;
+        line-height: normal
+    }
+    a
+    {
+        color: #00732F;
+        text-decoration: none;
+    }
+    hr
+    {
+        background-color: #E6E6E6;
+        border: 1px solid #E6E6E6;
+        height: 1px;
+        width: 100%;
+        text-align: left;
+        margin: 1.5em 0 1.5em 0;
+    }
+
+    pre
+    {
+        border: 1px solid #DDDDDD;
+        -moz-border-radius: 0.7em 0.7em 0.7em 0.7em;
+        -webkit-border-radius: 0.7em 0.7em 0.7em 0.7em;
+        border-radius: 0.7em 0.7em 0.7em 0.7em;
+        padding: 1em 1em 1em 1em;
+        overflow-x: auto;
+    }
+    table, pre
+    {
+        -moz-border-radius: 0.7em 0.7em 0.7em 0.7em;
+        -webkit-border-radius: 0.7em 0.7em 0.7em 0.7em;
+        border-radius: 0.7em 0.7em 0.7em 0.7em;
+        background-color: #F6F6F6;
+        border: 1px solid #E6E6E6;
+        border-collapse: separate;
+        margin-bottom: 2.5em;
+    }
+    pre {
+        font-size: 90%;
+        display: block;
+        overflow:hidden;
+    }
+    thead
+    {
+        margin-top: 0.5em;
+        font-weight: bold
+    }
+    th
+    {
+        padding: 0.5em 1.5em 0.5em 1em;
+        background-color: #E1E1E1;
+        border-left: 1px solid #E6E6E6;
+    }
+    td
+    {
+        padding: 0.25em 1.5em 0.25em 1em;
+    }
+
+    td.rightAlign
+    {
+        padding: 0.25em 0.5em 0.25em 1em;
+    }
+    table tr.odd
+    {
+        border-left: 1px solid #E6E6E6;
+        background-color: #F6F6F6;
+        color: black;
+    }
+    table tr.even
+    {
+        border-left: 1px solid #E6E6E6;
+        background-color: #ffffff;
+        color: #202020;
+    }
+
+    div.float-left
+    {
+        float: left; margin-right: 2em
+    }
+    div.float-right
+    {
+        float: right; margin-left: 2em
+    }
+
+    span.comment
+    {
+        color: #008B00;
+    }
+    span.string, span.char
+    {
+        color: #000084;
+    }
+    span.number
+    {
+        color: #a46200;
+    }
+    span.operator
+    {
+        color: #202020;
+    }
+    span.keyword
+    {
+        color: #840000;
+    }
+    span.name
+    {
+        color: black
+    }
+    span.type
+    {
+        font-weight: bold
+    }
+    span.type a:visited
+    {
+        color: #0F5300;
+    }
+    span.preprocessor
+    {
+        color: #404040
+    }
+/* end basic elements */
+
+/* font style elements */
+    .heading
+    {
+        font-weight: bold;
+        font-size: 125%;
+    }
+    .subtitle
+    {
+        font-size: 110%
+    }
+    .small-subtitle
+    {
+        font-size: 100%
+    }
+    .red
+    {
+        color:red;
+    }
+/* end font style elements */
+
+/* global settings*/
+    .header, .footer
+    {
+        display: block;
+        clear: both;
+        overflow: hidden;
+    }
+/* end global settings*/
+
+/* header elements */
+    .header .qtref
+    {
+        color: #00732F;
+        font-weight: bold;
+        font-size: 130%;
+    }
+
+    .header .content
+    {
+        margin-left: 5px;
+        margin-top: 5px;
+        margin-bottom: 0.5em;
+    }
+
+    .header .breadcrumb
+    {
+        font-size: 90%;
+        padding: 0.5em 0 0.5em 1em;
+        margin: 0;
+        background-color: #fafafa;
+        height: 1.35em;
+        border-bottom: 1px solid #d1d1d1;
+    }
+
+    .header .breadcrumb ul
+    {
+        margin: 0;
+        padding: 0;
+    }
+
+    .header .content
+    {
+        word-wrap: break-word;
+    }
+
+    .header .breadcrumb ul li
+    {
+        float: left;
+        background: url(../images/breadcrumb.png) no-repeat 0 3px;
+        padding-left: 1.5em;
+        margin-left: 1.5em;
+    }
+
+    .header .breadcrumb ul li.last
+    {
+        font-weight: normal;
+    }
+
+    .header .breadcrumb ul li a
+    {
+        color: #00732F;
+    }
+
+    .header .breadcrumb ul li.first
+    {
+        background-image: none;
+        padding-left: 0;
+        margin-left: 0;
+    }
+
+    .header .content ol li {
+        background: none;
+        margin-bottom: 1.0em;
+        margin-left: 1.2em;
+        padding-left: 0
+    }
+
+    .header .content li
+    {
+        background: url(../images/bullet_sq.png) no-repeat 0 5px;
+        margin-bottom: 1em;
+        padding-left: 1.2em;
+    }
+
+/* end header elements */
+
+/* content elements */
+    .content h1
+    {
+        font-weight: bold;
+        font-size: 130%
+    }
+
+    .content h2
+    {
+        font-weight: bold;
+        font-size: 120%;
+        width: 100%;
+    }
+    .content h3
+    {
+        font-weight: bold;
+        font-size: 110%;
+        width: 100%;
+    }
+    .content table p
+    {
+        margin: 0
+    }
+    .content ul
+    {
+        padding-left: 2.5em;
+    }
+    .content li
+    {
+        padding-top: 0.25em;
+        padding-bottom: 0.25em;
+    }
+    .content ul img {
+        vertical-align: middle;
+    }
+
+    .content a:visited
+    {
+        color: #4c0033;
+        text-decoration: none;
+    }
+
+    .content a:visited:hover
+    {
+        color: #4c0033;
+        text-decoration: underline;
+    }
+
+    a:hover
+    {
+        color: #4c0033;
+        text-decoration: underline;
+    }
+    descr p a
+    {
+        text-decoration: underline;
+    }
+
+    .descr p a:visited
+    {
+        text-decoration: underline;
+    }
+
+    .alphaChar{
+        width:95%;
+        background-color:#F6F6F6;
+        border:1px solid #E6E6E6;
+        -moz-border-radius: 7px 7px 7px 7px;
+        border-radius: 7px 7px 7px 7px;
+        -webkit-border-radius: 7px 7px 7px 7px;
+        font-size:12pt;
+        padding-left:10px;
+        margin-top:10px;
+        margin-bottom:10px;
+    }
+    .flowList{
+        /*vertical-align:top;*/
+        /*margin:20px auto;*/
+
+        column-count:3;
+        -webkit-column-count:3;
+        -moz-column-count:3;
+/*
+        column-width:100%;
+        -webkit-column-width:200px;
+        -col-column-width:200px;
+*/
+        column-gap:41px;
+        -webkit-column-gap:41px;
+        -moz-column-gap:41px;
+
+        column-rule: 1px dashed #ccc;
+        -webkit-column-rule: 1px dashed #ccc;
+        -moz-column-rule: 1px dashed #ccc;
+    }
+
+    .flowList dl{
+    }
+    .flowList dd{
+        /*display:inline-block;*/
+        margin-left:10px;
+        min-width:250px;
+        line-height: 1.5;
+        min-width:100%;
+        min-height:15px;
+    }
+
+    .flowList dd a{
+    }
+
+    .mainContent
+    {
+        padding-left:5px;
+    }
+
+    .content .flowList p{
+        padding:0px;
+    }
+
+    .content .alignedsummary
+    {
+        margin: 15px;
+    }
+
+
+    .qmltype
+    {
+        text-align: center;
+        font-size: 120%;
+    }
+    .qmlreadonly
+    {
+        padding-left: 5px;
+        float: right;
+        color: #254117;
+    }
+
+    .qmldefault
+    {
+        padding-left: 5px;
+        float: right;
+        color: red;
+    }
+
+    .qmldoc
+    {
+    }
+
+    .generic .alphaChar{
+        margin-top:5px;
+    }
+
+    .generic .odd .alphaChar{
+        background-color: #F6F6F6;
+    }
+
+    .generic .even .alphaChar{
+        background-color: #FFFFFF;
+    }
+
+    .memItemRight{
+        padding: 0.25em 1.5em 0.25em 0;
+    }
+    .highlightedCode
+    {
+        margin: 1.0em;
+    }
+    .annotated td {
+        padding: 0.25em 0.5em 0.25em 0.5em;
+    }
+
+    .toc
+    {
+        font-size: 80%
+    }
+
+    .header .content .toc ul
+    {
+        padding-left: 0px;
+    }
+
+    .content .toc h3 {
+        border-bottom: 0px;
+        margin-top: 0px;
+    }
+
+    .content .toc h3 a:hover {
+        color: #00732F;
+        text-decoration: none;
+    }
+
+    .content .toc .level2
+    {
+        margin-left: 1.5em;
+    }
+
+    .content .toc .level3
+    {
+        margin-left: 3.0em;
+    }
+
+    .content ul li
+    {
+        background: url(../images/bullet_sq.png) no-repeat 0 0.7em;
+        padding-left: 1em
+    }
+
+    .content .toc li
+    {
+        background: url(../images/bullet_dn.png) no-repeat 0 5px;
+        padding-left: 1em
+    }
+
+    .relpage
+    {
+        -moz-border-radius: 7px 7px 7px 7px;
+        -webkit-border-radius: 7px 7px 7px 7px;
+        border-radius: 7px 7px 7px 7px;
+        border: 1px solid #DDDDDD;
+        padding: 25px 25px;
+        clear: both;
+    }
+    .relpage ul
+    {
+        float: none;
+        padding: 1.5em;
+    }
+
+    h3.fn, span.fn
+    {
+        -moz-border-radius:7px 7px 7px 7px;
+        -webkit-border-radius:7px 7px 7px 7px;
+        border-radius:7px 7px 7px 7px;
+        background-color: #F6F6F6;
+        border-width: 1px;
+        border-style: solid;
+        border-color: #E6E6E6;
+        font-weight: bold;
+        word-spacing:3px;
+        padding:3px 5px;
+    }
+
+    .functionIndex {
+        font-size:12pt;
+        word-spacing:10px;
+        margin-bottom:10px;
+        background-color: #F6F6F6;
+        border-width: 1px;
+        border-style: solid;
+        border-color: #E6E6E6;
+        -moz-border-radius: 7px 7px 7px 7px;
+        -webkit-border-radius: 7px 7px 7px 7px;
+        border-radius: 7px 7px 7px 7px;
+        width:100%;
+    }
+
+    .centerAlign
+    {
+        text-align:center;
+    }
+
+    .rightAlign
+    {
+        text-align:right;
+    }
+
+    .leftAlign
+    {
+        text-align:left;
+    }
+
+    .topAlign{
+        vertical-align:top
+    }
+
+    .functionIndex a{
+        display:inline-block;
+    }
+
+/* end content elements */
+/* footer elements */
+
+    .footer
+    {
+        color: #393735;
+        font-size: 0.75em;
+        text-align: center;
+        padding-top: 1.5em;
+        padding-bottom: 1em;
+        background-color: #E6E7E8;
+        margin: 0;
+    }
+    .footer p
+    {
+        margin: 0.25em
+    }
+    .small
+    {
+        font-size: 0.5em;
+    }
+/* end footer elements */
+
+    .item {
+      float: left;
+      position: relative;
+      width: 100%;
+      overflow: hidden;
+    }
+
+
+    .item .primary {
+      margin-right: 220px;
+      position: relative;
+    }
+
+    .item hr {
+      margin-left: -220px;
+    }
+
+    .item .secondary {
+      float: right;
+      width: 200px;
+      position: relative;
+    }
+
+    .item .cols {
+      clear: both;
+      display: block;
+    }
+
+    .item .cols .col {
+      float: left;
+      margin-left: 1.5%;
+    }
+
+    .item .cols .col.first {
+      margin-left: 0;
+    }
+
+    .item .cols.two .col {
+      width: 45%;
+    }
+
+    .item .box {
+      margin: 0 0 10px 0;
+    }
+
+    .item .box h3 {
+      margin: 0 0 10px 0;
+    }
+
+    .cols.unclear {
+        clear:none;
+    }
+}
+
+/* end of screen media */
+
+/* start of print media */
+
+@media print
+{
+    input, textarea, .header, .footer, .toolbar, .feedback, .wrapper .hd, .wrapper .bd .sidebar, .wrapper .ft, #feedbackBox, #blurpage, .toc, .breadcrumb, .toolbar, .floatingResult
+    {
+        display: none;
+        background: none;
+    }
+    .content
+    {
+        background: none;
+        display: block;
+        width: 100%; margin: 0; float: none;
+    }
+}
+/* end of print media */
+
+
+/* modify the TOC layouts */
+div.toc ul {
+    padding-left: 20px;
+}
+div.toc li {
+    padding-left: 4px;
+}
+/* Remove the border around images*/
+a img
+{
+    border:none;
+}
+
+/*Add styling to the front pages*/
+
+.threecolumn_area
+{
+    padding-top: 20px;
+    padding-bottom: 20px;
+}
+.threecolumn_piece
+{
+    display: inline-block;
+    margin-left: 78px;
+    margin-top: 8px;
+    padding: 0;
+    vertical-align: top;
+    width: 25.5%;
+}
+div.threecolumn_piece ul {
+    list-style-type: none;
+    padding-left: 0px;
+    margin-top: 2px;
+}
+div.threecolumn_piece p {
+    margin-bottom: 7px;
+    color: #5C626E;
+    text-decoration: none;
+    font-weight: bold;
+}
+div.threecolumn_piece li {
+    padding-left: 0px;
+    margin-bottom: 5px;
+}
+div.threecolumn_piece a {
+    font-weight: normal;
+}
+/* Add style to guide page*/
+.fourcolumn_area
+{
+    padding-top: 20px;
+    padding-bottom: 20px;
+}
+.fourcolumn_piece
+{
+    display: inline-block;
+    margin-left: 35px;
+    margin-top: 8px;
+    padding: 0;
+    vertical-align: top;
+    width: 21.3%;
+}
+div.fourcolumn_piece ul {
+    list-style-type: none;
+    padding-left: 0px;
+    margin-top: 2px;
+}
+div.fourcolumn_piece p {
+    margin-bottom: 7px;
+    color: #40444D;
+    text-decoration: none;
+    font-weight: bold;
+}
+div.fourcolumn_piece li {
+    padding-left: 0px;
+    margin-bottom: 5px;
+}
+div.fourcolumn_piece a {
+    font-weight: normal;
+}

=== added file 'documentation/css/reset.css'
--- documentation/css/reset.css	1970-01-01 00:00:00 +0000
+++ documentation/css/reset.css	2015-04-09 21:30:48 +0000
@@ -0,0 +1,8 @@
+/*
+Copyright (c) 2010, Yahoo! Inc. All rights reserved.
+Code licensed under the BSD License:
+http://developer.yahoo.com/yui/license.html
+version: 3.3.0
+build: 3167
+*/
+html{color:#000;background:#FFF;}body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,textarea,p,blockquote,th,td{margin:0;padding:0;}table{border-collapse:collapse;border-spacing:0;}fieldset,img{border:0;}address,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}li{list-style:none;}caption,th{text-align:left;}h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}q:before,q:after{content:'';}abbr,acronym{border:0;font-variant:normal;}sup{vertical-align:text-top;}sub{vertical-align:text-bottom;}input,textarea,select{font-family:inherit;font-size:inherit;font-weight:inherit;}input,textarea,select{*font-size:100%;}legend{color:#000;}
\ No newline at end of file

=== added file 'documentation/css/scratch.css'
--- documentation/css/scratch.css	1970-01-01 00:00:00 +0000
+++ documentation/css/scratch.css	2015-04-09 21:30:48 +0000
@@ -0,0 +1,104 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+body {
+	margin: 0;
+}
+div.toc ul {
+	padding: 0;
+}
+div.toc li {
+	margin-bottom: 3px;
+}
+h1.title {
+	font-size: 36px;
+	line-height: 1.1;
+	font-weight: normal;
+}
+h0, h2 {
+	font-size: 24px;
+	line-height: 1.2;
+	margin: 14px 0;
+	font-weight: normal;
+	display: block;
+}
+a:hover {
+	color: #dd4814;
+	text-decoration: underline;
+	outline: 0;
+}
+table, pre {
+	border-radius: 0;
+        white-space: pre-wrap;
+}
+.annotated td {
+	padding: 0.8em 1em 0.3em;
+}
+.wrapper {
+	width: 940px;
+	margin: 0 auto;
+}
+.main-content {
+	width: 668px;
+	position: relative;
+	left: 270px;
+}
+.title {
+	margin-left: -270px;
+	margin-top: 30px;
+	margin-bottom: 50px;
+}
+.toc {
+	margin-left: -270px;
+	font-size: 100%;
+	margin-bottom: 40px;
+    padding: 0;
+    z-index: 2;
+    position: absolute;
+    top: 100px;
+    width: 250px;
+}
+.breadcrumb {
+	position: relative;
+	left: -270px;
+	top: 30px;
+	width: auto;
+	padding-bottom: 30px;
+	margin-bottom: 30px;
+	float:left;
+}
+.breadcrumb li {
+	float: left;
+	margin-right: 8px;
+}
+.breadcrumb a:link,
+.breadcrumb a:visited {
+	color: #AEA79F;
+}
+.breadcrumb a:after {
+	content: '\0000a0\0000a0 >';
+}
+.title {
+	margin-top: 50px;
+	clear:both;
+}
+.breadcrumb + .toc {
+	top: 170px;
+}
+.breadcrumb p {
+    display: inline;
+}
+

=== added file 'documentation/qt-halide.qdocconf'
--- documentation/qt-halide.qdocconf	1970-01-01 00:00:00 +0000
+++ documentation/qt-halide.qdocconf	2015-04-09 21:30:48 +0000
@@ -0,0 +1,45 @@
+project = QtHalide
+description = Qt Halide Documentation
+sourcedirs = ./
+sourcedirs += ../src/QtHalide
+headerdirs = ../src/QtHalide
+exampledirs += snippets
+sources.fileextensions = "*.qdoc *.cpp"
+headers.fileextensions = "*.h"
+outputdir = html
+outputformats = HTML
+version = 1.1
+syntaxhighlighting = true
+sourceencoding = UTF-8
+outputencoding = UTF-8
+
+HTML.templatedir = .
+HTML.endheader = "</head>\n"
+HTML.nobreadcrumbs = "true"
+
+HTML.stylesheets = \
+    css/reset.css \
+    css/qtquick.css \
+    css/base.css \
+    css/scratch.css
+
+HTML.headerstyles = \
+  "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/reset.css\" />\n" \
+  "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/qtquick.css\" />\n" \
+  "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/base.css\" />\n" \
+  "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/scratch.css\" />\n"
+
+HTML.postheader = \
+    "   <div class=\"wrapper\">\n" \
+    "   <div class=\"main-content\">\n" 
+
+HTML.footer = \
+    "</div></div>\n" \
+    "<div class=\"shadow\"></div>\n" \
+    "<footer>\n" \
+    "	<div>\n" \
+    "		<nav role=\"navigation\" class=\"clearfix\">\n" \
+    "		</nav>\n" \
+    "		<p>&copy; 2015 Canonical Ltd. Ubuntu and Canonical are registered trademarks of Canonical Ltd.</p>\n" \
+    "	</div>\n" \
+    "</footer>\n"

=== modified file 'src/QtHalide/halide_function.cpp'
--- src/QtHalide/halide_function.cpp	2015-04-08 18:49:13 +0000
+++ src/QtHalide/halide_function.cpp	2015-04-09 21:30:48 +0000
@@ -23,6 +23,54 @@
 #include "halide_image.h"
 #include "halide_transform_worker.h"
 
+/*!
+    \qmltype HalideFunction
+    \inqmlmodule QtHalide 0.1
+    \brief Instantiates a Halide function and allows setting its parameters so that it can be used in a \l HalideTransform.
+
+    Assign a \l name to specify which function generator to use. A suitable
+    generator needs to be linked to the application or to a library loaded by
+    the application. If the generator is not compiled ahead of time then it will
+    be compiled just in time when the HalideFunction is used in any \l HalideTransform.
+
+    To assign parameters to the underlying function you need to define QML
+    properties on the HalideFunction instance, with types and names matching
+    the parameters you want to set. You will receive warning messages if you are
+    missing some properties or use the wrong types.
+
+    For example if we have a generator declared as follows:
+
+    \code
+
+    class Rotation : public HalideGeneratorExtended<Rotation> {
+    public:
+        ImageParam input{ Halide::type_of<uint8_t>(), 3, "input" };
+        Param<float> angle{ "angle", 1.0 };
+
+        // ...
+
+    };
+
+    Halide::RegisterGenerator<Rotation> register_rotation{"rotation"};
+
+    \endcode
+
+    Then the corresponding QML that insteantiates an HalideFunction using it
+    should be:
+
+    \qml
+
+    HalideFunction {
+        name: "rotation"
+        property HalideImage input
+        property real angle: 45.0
+    }
+
+    \endqml
+
+    If you want to temporarily disable the function, use the \l enabled property.
+*/
+
 HalideFunction::HalideFunction(QObject *parent) :
     QObject(parent),
     m_enabled(true),
@@ -31,6 +79,13 @@
 {
 }
 
+/*!
+    \qmlproperty string HalideFunction::name
+
+    Name of the function generator to use. It is usually a fatal error to
+    use a name that does not correspond to any generator available at runtime
+    to the current executable.
+*/
 QString HalideFunction::name() const
 {
     return m_name;
@@ -45,6 +100,12 @@
     }
 }
 
+/*!
+    \qmlproperty bool HalideFunction::enabled
+
+    If set to false the function will behave as if it was not present in any
+    list of functions it is part of within an \l HalideTransform.
+*/
 bool HalideFunction::enabled() const
 {
     return m_enabled;

=== modified file 'src/QtHalide/halide_function_list_model.cpp'
--- src/QtHalide/halide_function_list_model.cpp	2015-04-08 15:48:49 +0000
+++ src/QtHalide/halide_function_list_model.cpp	2015-04-09 21:30:48 +0000
@@ -16,10 +16,32 @@
 
 #include "halide_function_list_model.h"
 
+/*!
+    \qmltype HalideFunctionListModel
+    \inqmlmodule QtHalide 0.1
+    \brief Allows accessing and manipulating a list of \l HalideFunction instances.
+
+    Add functions to the end of the list by calling \l append or in any location
+    within by calling \l insert. Shift a function to a different place in the
+    list by calling \l move.
+
+    Remove a function from the list by calling \l remove or \l clear to remove
+    all of them in one go.
+
+    Access functions by index using \l get and \l count to know how long the
+    list is.
+*/
+
 HalideFunctionListModel::HalideFunctionListModel(QObject* parent) : QAbstractListModel(parent)
 {
 }
 
+/*!
+    \qmlmethod HalideFunctionListModel::clear()
+
+    Removes all functions from the list.
+*/
+
 void HalideFunctionListModel::clear()
 {
     beginRemoveRows(QModelIndex(), 0, m_list.size() - 1);
@@ -28,16 +50,33 @@
     Q_EMIT countChanged();
 }
 
+/*!
+    \qmlproperty int HalideFunctionListModel::count
+
+    Returns the number of items in the list.
+*/
 int HalideFunctionListModel::count()
 {
     return m_list.size();
 }
 
+/*!
+    \qmlmethod HalideFunctionListModel::get(row)
+
+    Returns the item at the zero-based index \a row, or null if the index is
+    out of bounds.
+*/
 HalideFunction* HalideFunctionListModel::get(int row)
 {
     return data(index(row)).value<HalideFunction*>();
 }
 
+
+/*!
+    \qmlmethod HalideFunctionListModel::append(function)
+
+    Appends a \a function to the end of the list.
+*/
 void HalideFunctionListModel::append(HalideFunction* function)
 {
     insert(m_list.size(), function);
@@ -64,6 +103,13 @@
     Q_EMIT countChanged();
 }
 
+/*!
+    \qmlmethod HalideFunctionListModel::insert(index, function)
+
+    Inserts a \a function in the list at the specified zero-based \a index.
+    If the \a index is is out of bounds then the nearest index within bounds
+    will be used as the location for the insert operation.
+*/
 void HalideFunctionListModel::insert(int index, HalideFunction* function)
 {
     if (!function) {
@@ -80,6 +126,12 @@
     Q_EMIT countChanged();
 }
 
+/*!
+    \qmlmethod HalideFunctionListModel::remove(index)
+
+    Removes the function at the specified zero-based \a index from the list, if
+    the index is not out of bounds.
+*/
 bool HalideFunctionListModel::remove(int index)
 {
     if (index < 0 || index >= m_list.size()) {
@@ -94,11 +146,23 @@
     return true;
 }
 
+/*!
+    \qmlmethod HalideFunctionListModel::remove(function)
+
+    If the specified \a function is in the list, it will be removed from it.
+*/
 bool HalideFunctionListModel::remove(HalideFunction* function)
 {
     return remove(m_list.indexOf(function));
 }
 
+/*!
+    \qmlmethod HalideFunctionListModel::move(from, to)
+
+    Move a function in the list from the index specified by \a from
+    to the index specified by \a to.
+    If either of the indexes is out of bounds, no operation is performed.
+*/
 bool HalideFunctionListModel::move(int from, int to)
 {
     if (from < 0 || from >= m_list.size() || to < 0 || to > m_list.size()) {

=== modified file 'src/QtHalide/halide_image.cpp'
--- src/QtHalide/halide_image.cpp	2015-04-08 15:48:49 +0000
+++ src/QtHalide/halide_image.cpp	2015-04-09 21:30:48 +0000
@@ -18,6 +18,22 @@
 #include "halide_common.h"
 #include <QtCore/QDebug>
 
+/*!
+    \qmltype HalideImage
+    \inqmlmodule QtHalide 0.1
+    \brief HalideImage allows loading images that can be used with QtHalide.
+
+    Specify a \l source and a \l sourceSize to define how the image will be
+    loaded, then use the \l status property to monitor loading and check for
+    errors.
+
+    Images loaded with this class can be directly rendered with
+    \l HalideImageRenderer or passed as input buffers to an \l HalideFunction
+    (either directly or by setting the \l HalideTransform::input property of a
+    \l HalideTransform). Please see the documentation on these classes for
+    usage examples.
+*/
+
 HalideImage::HalideImage(QObject *parent) :
     QObject(parent),
     m_componentCompleted(false),
@@ -45,16 +61,56 @@
     scheduleReloadSource();
 }
 
+/*!
+    \qmlproperty QUrl HalideImage::source
+
+    Path of the image to be loaded. The URL may be absolute, or relative to the
+    URL of the component.
+*/
 QUrl HalideImage::source() const
 {
     return m_source;
 }
 
+void HalideImage::setSource(QUrl source)
+{
+    if (source != m_source) {
+        m_source = source;
+        scheduleReloadSource();
+        Q_EMIT sourceChanged();
+    }
+}
+
+/*!
+    \qmlproperty QSize HalideImage::sourceSize
+
+    This property sets the actual number of pixels stored for the loaded image
+    so that large images do not use more memory than necessary.
+
+    If the image's actual size is larger than the sourceSize, the image is
+    scaled down. If only one dimension of the size is set to greater than 0,
+    the other dimension is set in proportion to preserve the source image's
+    aspect ratio.
+*/
 QSize HalideImage::sourceSize() const
 {
     return m_sourceSize;
 }
 
+void HalideImage::setSourceSize(QSize sourceSize)
+{
+    if (sourceSize != m_sourceSize) {
+        m_sourceSize = sourceSize;
+        scheduleReloadSource();
+        Q_EMIT sourceSizeChanged();
+    }
+}
+
+/*!
+    \qmlproperty QSize HalideImage::size
+
+    Returns the actual size of the loaded image.
+*/
 QSize HalideImage::size() const
 {
     if (m_data) {
@@ -64,6 +120,15 @@
     }
 }
 
+/*!
+    \qmlproperty Status HalideImage::status
+    \value Null no source has been set and no image has been loaded
+    \value Loading loading the image is in progress
+    \value Error loading the image failed
+    \value Ready the image has been successfully loaded
+
+    Returns the loading status of the image.
+*/
 HalideImage::Status HalideImage::status() const
 {
     return m_status;
@@ -77,24 +142,6 @@
     }
 }
 
-void HalideImage::setSource(QUrl source)
-{
-    if (source != m_source) {
-        m_source = source;
-        scheduleReloadSource();
-        Q_EMIT sourceChanged();
-    }
-}
-
-void HalideImage::setSourceSize(QSize sourceSize)
-{
-    if (sourceSize != m_sourceSize) {
-        m_sourceSize = sourceSize;
-        scheduleReloadSource();
-        Q_EMIT sourceSizeChanged();
-    }
-}
-
 void HalideImage::setData(QSharedPointer<HalideImageData> data)
 {
     Q_ASSERT_X(!data.isNull(), "HalideImage::setData", "cannot set null data");

=== modified file 'src/QtHalide/halide_image_renderer.cpp'
--- src/QtHalide/halide_image_renderer.cpp	2015-04-08 15:48:49 +0000
+++ src/QtHalide/halide_image_renderer.cpp	2015-04-09 21:30:48 +0000
@@ -17,6 +17,72 @@
 #include "halide_image_renderer.h"
 #include <QtQuick/QQuickWindow>
 
+/*!
+    \qmltype HalideImageRenderer
+    \inqmlmodule QtHalide 0.1
+    \brief HalideImageRenderer is a QML Item used to display images loaded by \l HalideImage or the results of a \l HalideTransform.
+
+    Specify the image you want to render with the \l image property.
+
+    The \l fillMode, \l horizontalAlignment and \l verticalAlignment control
+    how the image is scaled and aligned in case the size of the rendered image
+    does not match the size of this Item.
+
+    You can use \l HalideImageRenderer for rendering the results of a \l HalideTransform
+    like this:
+
+
+    \qml
+
+    Item {
+        HalideTransform {
+            id: transform
+            live: true
+            input: HalideImage {
+                source: "photo.jpg"
+            }
+
+            HalideFunction {
+                name: "rotate"
+                property HalideImage input
+                property real angle: 45
+            }
+        }
+
+        HalideImageRenderer {
+            anchors.fill: parent
+            verticalAlignment: HalideImageRenderer.AlignVCenter
+            horizontalAlignment: HalideImageRenderer.AlignHCenter
+            fillMode: HalideImageRenderer.PreserveAspectFit
+            image: transform.output
+        }
+    }
+
+    \endqml
+
+    The example above will render the output of the transform, scale it to fill
+    the entire rendering area preserving the aspect ratio, then center it within
+    that area.
+
+    You can also directly render an \l HalideImage, like this:
+
+    \qml
+
+    HalideImageRenderer {
+        anchors.centerIn: parent
+        width: image.size.width
+        height: image.size.height
+        image: HalideImage {
+            source: "whatever.jpg"
+        }
+    }
+
+    \endqml
+
+    The above example will render the image in its original size, centered
+    inside the parent.
+*/
+
 HalideImageRenderer::HalideImageRenderer(QQuickItem *parent) :
     QQuickItem(parent),
     m_textureNeedsUpdate(true),
@@ -183,6 +249,11 @@
     return texture;
 }
 
+/*!
+    \qmlproperty HalideImage HalideImageRenderer::image
+
+    The image to be rendered.
+*/
 HalideImage* HalideImageRenderer::image() const
 {
     return m_image;
@@ -205,6 +276,14 @@
     }
 }
 
+/*!
+    \qmlproperty FillMode HalideImageRenderer::fillMode
+    \value PreserveAspectFit scale uniformly to fit without cropping
+    \value PreserveAspectCrop scale uniformly to fill, cropping if necessary
+
+    Set this property to define what happens when the rendered \l HalideImage
+    has a different size than this renderer.
+*/
 HalideImageRenderer::FillMode HalideImageRenderer::fillMode() const
 {
     return m_fillMode;
@@ -219,6 +298,15 @@
     }
 }
 
+/*!
+    \qmlproperty HorizontalAlignment HalideImageRenderer::horizontalAlignment
+    \value AlignLeft align the image to the left
+    \value AlignRight align the image to the right
+    \value AlignHCenter center the image horizontally
+
+    If the rendered and scaled image is smaller than the rendering area,
+    the value of this property decides how it is aligned horizontally within it.
+*/
 HalideImageRenderer::HorizontalAlignment HalideImageRenderer::horizontalAlignment() const
 {
     return m_horizontalAlignment;
@@ -233,6 +321,15 @@
     }
 }
 
+/*!
+    \qmlproperty VerticalAlignment HalideImageRenderer::verticalAlignment
+    \value AlignTop align the image to the top
+    \value AlignBottom align the image to the bottom
+    \value AlignVCenter center the image vertically
+
+    If the rendered and scaled image is smaller than the rendering area,
+    the value of this property decides how it is aligned vertically within it.
+*/
 HalideImageRenderer::VerticalAlignment HalideImageRenderer::verticalAlignment() const
 {
     return m_verticalAlignment;

=== modified file 'src/QtHalide/halide_transform.cpp'
--- src/QtHalide/halide_transform.cpp	2015-04-08 15:48:49 +0000
+++ src/QtHalide/halide_transform.cpp	2015-04-09 21:30:48 +0000
@@ -25,6 +25,69 @@
 #include <QtQuick/QQuickItem>
 #include <QtConcurrent/QtConcurrent>
 
+/*!
+    \qmltype HalideTransform
+    \inqmlmodule QtHalide 0.1
+    \brief Transforms an \l HalideImage by applying a chain of \l HalideFunction to it.
+
+    Assign the \l HalideImage that you want to trasnform to the \l input property.
+
+    Instantiate one or more \l HalideFunction and assign them to the \l functions
+    list model. The model is an instance of \l HalideFunctionListModel and as
+    such has various methods to allow manipulating and accessing the list.
+
+    The functions will be applied in sequence and the output will be available
+    through the \l output property. You can then save it to disk with \l saveToFile or
+    display it using an \l HalideImageRenderer.
+
+    As a convenience, since most functions operate on an input buffer, if a
+    property of type \l HalideImage named "input" exists on any HalideFunction
+    in the \l functions list, it will be assigned automatically the output of
+    the previous function in the list, or the \l HalideTransform's input if it
+    is the first in the list.
+    This allows more convenient chaining of functions without having to
+    explicitly assign the output of each one to the input of the next.
+
+
+    For example the following code will produce the correct output, even if the
+    input parameter of the various HalideFunctions has been left unset.
+
+    \qml
+
+    HalideTransform {
+        live: true
+        input: HalideImage {
+            source: "photo.jpg"
+        }
+
+        HalideFunction {
+            name: "rotate"
+            property HalideImage input
+            property real angle: 45
+        }
+
+        HalideFunction {
+            name: "saturation"
+            property HalideImage input
+            property real saturation: 1.8
+        }
+    }
+
+    \endqml
+
+    Changing any of the parameters on any of the functions in the list, or the
+    number or order of the items in the list, will cause the HalideTransform to
+    recompute the transform chain as efficiently as possible. You can also
+    call \l scheduleUpdate to request the transform to be recomputed.
+
+    While the output is being recomputed the \l updating property will be set
+    to true.
+
+    If you want to temporarily disable a transform from recomputing, for example
+    so that you can change several parameters in one go without too many
+    recomputations, you can set \l live to false while you do so.
+*/
+
 HalideTransform::HalideTransform(QObject *parent) :
     QObject(parent),
     m_componentCompleted(false),
@@ -83,6 +146,13 @@
     }
 }
 
+/*!
+    \qmlproperty bool HalideTransform::live
+
+    If set to false the transform will stop recomputing its output in reaction
+    to changes in the \l functions parameters or order, until set to true
+    again.
+*/
 bool HalideTransform::live() const
 {
     return m_live;
@@ -111,11 +181,23 @@
     }
 }
 
+/*!
+    \qmlproperty bool HalideTransform::updating
+
+    Set to true while the \l output is being recomputed.
+*/
 bool HalideTransform::updating() const
 {
     return m_updateTimer.isValid();
 }
 
+
+/*!
+    \qmlproperty HalideImage HalideTransform::input
+
+    The input of the transform, upon which the \l functions will be applied to
+    produce the \l output.
+*/
 HalideImage* HalideTransform::input() const
 {
     return m_input;
@@ -193,6 +275,13 @@
     }
 }
 
+
+/*!
+    \qmlproperty HalideImage HalideTransform::output
+
+    The output of the transform, that is the product of applying the \l functions
+    to the \l input image.
+*/
 HalideImage* HalideTransform::output() const
 {
     return m_output;
@@ -206,6 +295,12 @@
     }
 }
 
+
+/*!
+    \qmlmethod HalideTransform::scheduleUpdate()
+
+    Requests the transform to recompute its output.
+*/
 void HalideTransform::scheduleUpdate()
 {
     doUpdate(false);
@@ -291,6 +386,17 @@
     }
 }
 
+/*!
+    \qmlmethod HalideTransform::saveToFile(fileName)
+
+    Requests the transform to save its output to disk. The \a fileName
+    specifies the path of a file relative to the default pictures folder for the
+    current user. The image format is decided based on the file extension.
+
+    Returns true if the saving process was successfully started. The image is
+    actually saved to disk asynchronously and there is currently no way to know
+    if the operation succeeded.
+*/
 bool HalideTransform::saveToFile(QString fileName)
 {
     QString directory = QStandardPaths::writableLocation(QStandardPaths::PicturesLocation);
@@ -322,6 +428,18 @@
     }
 }
 
+/*!
+    \qmlproperty HalideFunctionListModel HalideTransform::functions
+
+    Access the model holding the list of \l HalideFunction that will be applied
+    to the \l input.
+
+    You can set this property to a QML list of \l HalideFunction
+    instances or read it to retrieve the \l HalideFunctionListModel and use its
+    methods to manipulate and access the functions list.
+
+    Set to an empty QML list to clear the model.
+*/
 QVariant HalideTransform::functions() const
 {
     return QVariant::fromValue(m_functionsModel);

=== modified file 'src/QtHalide/qthalide_qml_plugin.cpp'
--- src/QtHalide/qthalide_qml_plugin.cpp	2015-04-08 15:48:49 +0000
+++ src/QtHalide/qthalide_qml_plugin.cpp	2015-04-09 21:30:48 +0000
@@ -23,6 +23,11 @@
 #include "halide_image_renderer.h"
 #include "halide_transform_worker.h"
 
+/*! \qmlmodule QtHalide
+
+    A module allowing to use Halide from QML.
+*/
+
 void QtHalideQmlPlugin::registerTypes(const char *uri)
 {
     Q_ASSERT(uri == QLatin1String("QtHalide"));