Generate API documentation with Doxygen

Author: bastianeicher

.travis.yml

@@ -0,0 +1,13 @@
+sudo: required
+dist: trusty
+before_install:
+  - sudo apt-get install -y zeroinstall-injector
+script:
+  - doc/build.sh
+deploy:
+  provider: pages
+  skip-cleanup: true
+  local-dir: target/Documentation
+  github-token: $GITHUB_TOKEN
+  on:
+    tags: true

README.md

@@ -1,5 +1,6 @@
 # TypedRest for Java
 
+[![API documentation](https://img.shields.io/badge/api-docs-orange.svg)](https://typedrest.github.io/TypedRest-Java/)
 [![Build status](https://img.shields.io/appveyor/ci/TypedRest/typedrest-java.svg)](https://ci.appveyor.com/project/TypedRest/typedrest-java)
 
 TypedRest helps you build type-safe fluent-style REST API clients.

doc/Doxyfile

@@ -0,0 +1,20 @@
+PROJECT_NAME = "TypedRest for Java"
+
+INPUT = . ../annotations ../core ../vaadin
+USE_MDFILE_AS_MAINPAGE = main.md
+STRIP_FROM_PATH = ../src
+RECURSIVE = YES
+
+OUTPUT_DIRECTORY = ../target/Documentation
+GENERATE_TAGFILE = ../target/Documentation/typedrest-java.tag
+HTML_OUTPUT = .
+
+GENERATE_LATEX = NO
+CASE_SENSE_NAMES = NO
+
+OPTIMIZE_OUTPUT_JAVA = YES
+EXTRACT_PACKAGE = YES
+EXTRACT_STATIC = YES
+AUTOLINK_SUPPORT = NO
+WARN_IF_UNDOCUMENTED = NO
+QUIET = YES

doc/build.ps1

@@ -0,0 +1,16 @@
+$ErrorActionPreference = "Stop"
+pushd $(Split-Path -Path $MyInvocation.MyCommand.Definition -Parent)
+
+# Ensure 0install is in the PATH
+if (!(Get-Command 0install -ErrorAction SilentlyContinue)) {
+    mkdir -Force "$env:TEMP\zero-install" | Out-Null
+    Invoke-WebRequest "https://0install.de/files/0install.exe" -OutFile "$env:TEMP\zero-install\0install.exe"
+    $env:PATH = "$env:TEMP\zero-install;$env:PATH"
+}
+
+if (Test-Path ..\target\Documentation) {rm -Recurse -Force ..\artifacts\Documentation}
+mkdir ..\target\Documentation | Out-Null
+
+0install run --batch http://repo.roscidus.com/devel/doxygen
+
+popd

doc/build.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -e
+cd `dirname $0`
+
+rm -rf ../target/Documentation
+mkdir -p ../target/Documentation
+
+0install run http://repo.roscidus.com/devel/doxygen

doc/main.md

@@ -0,0 +1,9 @@
+# TypedRest for Java
+
+TypedRest helps you build type-safe fluent-style REST API clients.
+
+This website documents the TypedRest Java API.
+
+## Building and contributing
+
+See the **[GitHub project](https://github.com/TypedRest/TypedRest-Java)** for more information.