Skip to content

Commit

Permalink
#892 Implement generation of combined JavaDoc pages
Browse files Browse the repository at this point in the history
  • Loading branch information
ipolevoy committed Sep 27, 2019
1 parent 2442d02 commit 51d1848
Show file tree
Hide file tree
Showing 31 changed files with 220 additions and 17 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* Model instrumentation, see <a href="http://javalite.io/instrumentation">Instrumentation</a>.
*/
package org.javalite.instrumentation;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* Contains annotations for overriding default behaviour.
*/
package org.javalite.activejdbc.annotations;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* Contains classes describing various association types.
*/
package org.javalite.activejdbc.associations;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* Classes for operations with caches.
*/
package org.javalite.activejdbc.cache;
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@



/**
* Classes to manage connections to databases. Mostly used internally by the framework./
*
* See <a href="http://javalite.io/database_configuration">Database configuration</a>.
*/
package org.javalite.activejdbc.connection_config;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* Classes to manage data conversions, se <a href="http://javalite.io/data_conversions">Data conversions</a>
*/
package org.javalite.activejdbc.conversion;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* Classes to manage database dialects, used internally.
*/
package org.javalite.activejdbc.dialects;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* Log management, see <a href="http://javalite.io/logging">Logging</a>
*/
package org.javalite.activejdbc.logging;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* ActiveJDBC - the agile Java ORM.
*/
package org.javalite.activejdbc;
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@



/**
* ActiveJDBC - collection of statistics on queries.
* See <a href="http://javalite.io/statistics_reporting">Statistics</a>
*/
package org.javalite.activejdbc.statistics;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* TDD support , see <a href="http://javalite.io/testing_with_db_connection">Testing with database connection</a>
*/
package org.javalite.activejdbc.test;
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@



/**
* Data validation , see
* <a href="http://javalite.io/validations">Validations.</a>
*/
package org.javalite.activejdbc.validation;
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@



/**
* Primitive example of opening anc closing connection for servlets.
*
*/
package org.javalite.activejdbc.web;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* LessC integration, see <a href="http://javalite.io/lessc">LessC</a>.
*/
package org.javalite.lessc.maven;
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@



/**
* ActiveWeb controller annotations, see <a href="http://javalite.io/controllers">Controllers</a>
* and <a href="http://javalite.io/routing">Routing</a>.
*
*/
package org.javalite.activeweb.annotations;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* Controller Filters, see <a href="http://javalite.io/controller_filters">Controller filters</a>
*/
package org.javalite.activeweb.controller_filters;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* Some abstract controllers.
*/
package org.javalite.activeweb.controllers;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* Freemarker Tags, see <a href="http://javalite.io/views">Views</a>.
*/
package org.javalite.activeweb.freemarker;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* ActiveWeb - the agile java framework
*/
package org.javalite.activeweb;
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@



/**
* AppConfig for configuring your system for different environments.
* See <a href="http://javalite.io/app-config">AppConfig</a>.
*/
package org.javalite.app_config;
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@



/**
* DBMigrator,
* See <a href="http://javalite.io/database_migrations">AppConfig</a>.
*/
package org.javalite.db_migrator;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* JavaLite Async, see <a href="http://javalite.io/async">JavaLite Async</a>.
*/
package org.javalite.async;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* This package is a Swiss Army knife of utilities used in JavaLite as well as outside
*/
package org.javalite.common;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* JavaLite HTTP library.
*/
package org.javalite.http;
16 changes: 0 additions & 16 deletions javalite-common/src/main/java/org/javalite/http/package.html

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* JavaLite Logging, see http://javalite.io/logging
*/
package org.javalite.logging;
7 changes: 7 additions & 0 deletions javalite-common/src/main/java/org/javalite/package-info.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* This is a root package for all classes in JavaLite ecosystem.
*/
package org.javalite;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* JSpec library, see http://javalite.io/jspec
*/
package org.javalite.test.jspec;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@



/**
* Package contains utilities classes to use in tests.
*/
package org.javalite.test;
3 changes: 2 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -152,9 +152,10 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.0.1</version>
<configuration>
<stylesheetfile>javadoc/stylesheet.css</stylesheetfile>
<!--<stylesheetfile>javadoc/stylesheet.css</stylesheetfile>-->
<javadocDirectory>javadoc</javadocDirectory>
<doclint>none</doclint>
<additionalJOption>--no-module-directories</additionalJOption>
</configuration>
</plugin>
</plugins>
Expand Down
13 changes: 13 additions & 0 deletions scripts/javadoc.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
#!/usr/bin/env bash


if [ $# -eq 0 ]
then
echo "Must provide a fixed version or a snapshot"
exit 1
fi

mvn clean javadoc:aggregate
mkdir ../javalite.github.io/$1
cp -r target/site/apidocs/* ../javalite.github.io/$1
cd ../javalite.github.io/
git add .
git commit -m "JavaDoc update for $1"
git push

0 comments on commit 51d1848

Please sign in to comment.