#107 JavaDoc improvements for the Adapter example

This commit is contained in:
Ilkka Seppala 2015-08-17 23:11:15 +03:00
parent fd85a2f848
commit ef6a34ef74
3 changed files with 69 additions and 65 deletions

View File

@ -6,14 +6,18 @@ package com.iluwatar.adapter;
* the adaptee's interface whereas the object adapter uses composition to * the adaptee's interface whereas the object adapter uses composition to
* contain the adaptee in the adapter object. This example uses the object * contain the adaptee in the adapter object. This example uses the object
* adapter approach. * adapter approach.
* * <p>
* The Adapter (GnomeEngineer) converts the interface of the target class * The Adapter ({@link GnomeEngineer}) converts the interface of the target class
* (GoblinGlider) into a suitable one expected by the client * ({@link GoblinGlider}) into a suitable one expected by the client
* (GnomeEngineeringManager). * ({@link GnomeEngineeringManager}).
* *
*/ */
public class App { public class App {
/**
* Program entry point
* @param args command line args
*/
public static void main(String[] args) { public static void main(String[] args) {
Engineer manager = new GnomeEngineeringManager(); Engineer manager = new GnomeEngineeringManager();
manager.operateDevice(); manager.operateDevice();

View File

@ -2,8 +2,8 @@ package com.iluwatar.adapter;
/** /**
* *
* Adapter class. Adapts the interface of the device (GoblinGlider) into * Adapter class. Adapts the interface of the device ({@link GoblinGlider}) into
* Engineer interface expected by the client (GnomeEngineeringManager). * {@link Engineer} interface expected by the client ({@link GnomeEngineeringManager}).
* *
*/ */
public class GnomeEngineer implements Engineer { public class GnomeEngineer implements Engineer {

View File

@ -2,7 +2,7 @@ package com.iluwatar.adapter;
/** /**
* *
* GnomeEngineering manager uses Engineer to operate devices. * GnomeEngineering manager uses {@link Engineer} to operate devices.
* *
*/ */
public class GnomeEngineeringManager implements Engineer { public class GnomeEngineeringManager implements Engineer {