#107 Improve JavaDoc for Prototype

This commit is contained in:
Ilkka Seppala 2015-08-21 22:45:03 +03:00
parent 8fb0ec1bf9
commit 0db6581cfd
12 changed files with 267 additions and 208 deletions

View File

@ -2,13 +2,17 @@ package com.iluwatar.prototype;
/**
*
* In Prototype we have a factory class (HeroFactoryImpl) producing objects by
* cloning existing ones. In this example the factory's prototype objects are
* In Prototype we have a factory class ({@link HeroFactoryImpl}) producing objects by
* cloning the existing ones. In this example the factory's prototype objects are
* given as constructor parameters.
*
*/
public class App {
/**
* Program entry point
* @param args command line args
*/
public static void main(String[] args) {
HeroFactory factory;
Mage mage;

View File

@ -1,5 +1,10 @@
package com.iluwatar.prototype;
/**
*
* Beast
*
*/
public abstract class Beast extends Prototype {
@Override

View File

@ -1,5 +1,10 @@
package com.iluwatar.prototype;
/**
*
* ElfBeast
*
*/
public class ElfBeast extends Beast {
public ElfBeast() {

View File

@ -1,5 +1,10 @@
package com.iluwatar.prototype;
/**
*
* ElfMage
*
*/
public class ElfMage extends Mage {
public ElfMage() {

View File

@ -1,5 +1,10 @@
package com.iluwatar.prototype;
/**
*
* ElfWarlord
*
*/
public class ElfWarlord extends Warlord {
public ElfWarlord() {

View File

@ -1,5 +1,10 @@
package com.iluwatar.prototype;
/**
*
* Mage
*
*/
public abstract class Mage extends Prototype {
@Override

View File

@ -1,5 +1,10 @@
package com.iluwatar.prototype;
/**
*
* OrcBeast
*
*/
public class OrcBeast extends Beast {
public OrcBeast() {

View File

@ -1,5 +1,10 @@
package com.iluwatar.prototype;
/**
*
* OrcMage
*
*/
public class OrcMage extends Mage {
public OrcMage() {

View File

@ -1,5 +1,10 @@
package com.iluwatar.prototype;
/**
*
* OrcWarlord
*
*/
public class OrcWarlord extends Warlord {
public OrcWarlord() {

View File

@ -1,5 +1,10 @@
package com.iluwatar.prototype;
/**
*
* Prototype
*
*/
public abstract class Prototype implements Cloneable {
@Override

View File

@ -1,5 +1,10 @@
package com.iluwatar.prototype;
/**
*
* Warlord
*
*/
public abstract class Warlord extends Prototype {
@Override

View File

@ -4,6 +4,11 @@ import org.junit.Test;
import com.iluwatar.prototype.App;
/**
*
* Application test
*
*/
public class AppTest {
@Test