From d033f73a11d276e885b6675bb48d47a9ee068493 Mon Sep 17 00:00:00 2001 From: Miguel Angel Astor Romero Date: Fri, 24 Oct 2014 09:55:03 -0430 Subject: [PATCH] Added package-info documentation for all packages. --- .../ceidecpong/android/package-info.java | 20 ++++++++++++++++ .../ecs/components/package-info.java | 21 +++++++++++++++++ .../ceidecpong/ecs/entities/package-info.java | 23 +++++++++++++++++++ .../ecs/systems/messaging/package-info.java | 21 +++++++++++++++++ .../ceidecpong/ecs/systems/package-info.java | 20 ++++++++++++++++ .../ceidecpong/effects/package-info.java | 20 ++++++++++++++++ .../ceidecpong/interfaces/package-info.java | 20 ++++++++++++++++ .../mikykr5/ceidecpong/package-info.java | 21 +++++++++++++++++ .../ceidecpong/states/package-info.java | 23 +++++++++++++++++++ .../utils/managers/package-info.java | 20 ++++++++++++++++ .../ceidecpong/utils/package-info.java | 20 ++++++++++++++++ .../ceidecpong/desktop/package-info.java | 20 ++++++++++++++++ 12 files changed, 249 insertions(+) create mode 100644 android/src/com/gamejolt/mikykr5/ceidecpong/android/package-info.java create mode 100644 core/src/com/gamejolt/mikykr5/ceidecpong/ecs/components/package-info.java create mode 100644 core/src/com/gamejolt/mikykr5/ceidecpong/ecs/entities/package-info.java create mode 100644 core/src/com/gamejolt/mikykr5/ceidecpong/ecs/systems/messaging/package-info.java create mode 100644 core/src/com/gamejolt/mikykr5/ceidecpong/ecs/systems/package-info.java create mode 100644 core/src/com/gamejolt/mikykr5/ceidecpong/effects/package-info.java create mode 100644 core/src/com/gamejolt/mikykr5/ceidecpong/interfaces/package-info.java create mode 100644 core/src/com/gamejolt/mikykr5/ceidecpong/package-info.java create mode 100644 core/src/com/gamejolt/mikykr5/ceidecpong/states/package-info.java create mode 100644 core/src/com/gamejolt/mikykr5/ceidecpong/utils/managers/package-info.java create mode 100644 core/src/com/gamejolt/mikykr5/ceidecpong/utils/package-info.java create mode 100644 desktop/src/com/gamejolt/mikykr5/ceidecpong/desktop/package-info.java diff --git a/android/src/com/gamejolt/mikykr5/ceidecpong/android/package-info.java b/android/src/com/gamejolt/mikykr5/ceidecpong/android/package-info.java new file mode 100644 index 0000000..968c9cf --- /dev/null +++ b/android/src/com/gamejolt/mikykr5/ceidecpong/android/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2014, Miguel Angel Astor Romero + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Read the LICENSE file for more details. + */ + +/** + * This package contains the Android initializer of the game, along with any other Android specific classes of the game. + */ +package com.gamejolt.mikykr5.ceidecpong.android; diff --git a/core/src/com/gamejolt/mikykr5/ceidecpong/ecs/components/package-info.java b/core/src/com/gamejolt/mikykr5/ceidecpong/ecs/components/package-info.java new file mode 100644 index 0000000..8f9a39a --- /dev/null +++ b/core/src/com/gamejolt/mikykr5/ceidecpong/ecs/components/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2014, Miguel Angel Astor Romero + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Read the LICENSE file for more details. + */ + +/** + * This package contains all the {@link com.badlogic.ashley.core.Component} subclasses that can be used + * for the entities in the game. + */ +package com.gamejolt.mikykr5.ceidecpong.ecs.components; diff --git a/core/src/com/gamejolt/mikykr5/ceidecpong/ecs/entities/package-info.java b/core/src/com/gamejolt/mikykr5/ceidecpong/ecs/entities/package-info.java new file mode 100644 index 0000000..971930e --- /dev/null +++ b/core/src/com/gamejolt/mikykr5/ceidecpong/ecs/entities/package-info.java @@ -0,0 +1,23 @@ +/* + * Copyright (c) 2014, Miguel Angel Astor Romero + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Read the LICENSE file for more details. + */ + +/** + * This package contains the {@link com.badlogic.ashley.core.Entity} initializers. These initializers are responsible for + * setting all initial permanent and transitory entities in each respective game. All initializers should subclass + * {@link com.gamejolt.mikykr5.ceidecpong.ecs.entities.EntityInitializerBase} to ensure that the + * {@link com.gamejolt.mikykr5.ceidecpong.states.InGameState} implementation can use them without modifications. + */ +package com.gamejolt.mikykr5.ceidecpong.ecs.entities; diff --git a/core/src/com/gamejolt/mikykr5/ceidecpong/ecs/systems/messaging/package-info.java b/core/src/com/gamejolt/mikykr5/ceidecpong/ecs/systems/messaging/package-info.java new file mode 100644 index 0000000..7407dc6 --- /dev/null +++ b/core/src/com/gamejolt/mikykr5/ceidecpong/ecs/systems/messaging/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2014, Miguel Angel Astor Romero + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Read the LICENSE file for more details. + */ + +/** + * This package contains classes that can be used to send messages between different {@link com.badlogic.ashley.core.EntitySystem} + * subclasses when relevant game events occur in certain systems and must be propagated to other systems. + */ +package com.gamejolt.mikykr5.ceidecpong.ecs.systems.messaging; diff --git a/core/src/com/gamejolt/mikykr5/ceidecpong/ecs/systems/package-info.java b/core/src/com/gamejolt/mikykr5/ceidecpong/ecs/systems/package-info.java new file mode 100644 index 0000000..0ae2c26 --- /dev/null +++ b/core/src/com/gamejolt/mikykr5/ceidecpong/ecs/systems/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2014, Miguel Angel Astor Romero + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Read the LICENSE file for more details. + */ + +/** + * This package contains all the {@link com.badlogic.ashley.core.Entity} processing systems used by the game. + */ +package com.gamejolt.mikykr5.ceidecpong.ecs.systems; diff --git a/core/src/com/gamejolt/mikykr5/ceidecpong/effects/package-info.java b/core/src/com/gamejolt/mikykr5/ceidecpong/effects/package-info.java new file mode 100644 index 0000000..28cf253 --- /dev/null +++ b/core/src/com/gamejolt/mikykr5/ceidecpong/effects/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2014, Miguel Angel Astor Romero + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Read the LICENSE file for more details. + */ + +/** + * This package contains reusable graphical effects. + */ +package com.gamejolt.mikykr5.ceidecpong.effects; diff --git a/core/src/com/gamejolt/mikykr5/ceidecpong/interfaces/package-info.java b/core/src/com/gamejolt/mikykr5/ceidecpong/interfaces/package-info.java new file mode 100644 index 0000000..171ed97 --- /dev/null +++ b/core/src/com/gamejolt/mikykr5/ceidecpong/interfaces/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2014, Miguel Angel Astor Romero + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Read the LICENSE file for more details. + */ + +/** + * This package contains java interfaces used primarily for the Observer design pattern. + */ +package com.gamejolt.mikykr5.ceidecpong.interfaces; diff --git a/core/src/com/gamejolt/mikykr5/ceidecpong/package-info.java b/core/src/com/gamejolt/mikykr5/ceidecpong/package-info.java new file mode 100644 index 0000000..2eb9f8c --- /dev/null +++ b/core/src/com/gamejolt/mikykr5/ceidecpong/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2014, Miguel Angel Astor Romero + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Read the LICENSE file for more details. + */ + +/** + * This is the core package of the game. It contains the {@link com.gamejolt.mikykr5.ceidecpong.GameCore} which is the class + * responsible for executing the game itself, along with other project-wise classes. + */ +package com.gamejolt.mikykr5.ceidecpong; diff --git a/core/src/com/gamejolt/mikykr5/ceidecpong/states/package-info.java b/core/src/com/gamejolt/mikykr5/ceidecpong/states/package-info.java new file mode 100644 index 0000000..6007aad --- /dev/null +++ b/core/src/com/gamejolt/mikykr5/ceidecpong/states/package-info.java @@ -0,0 +1,23 @@ +/* + * Copyright (c) 2014, Miguel Angel Astor Romero + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Read the LICENSE file for more details. + */ + +/** + * This package contains the implementations of the different top level states of the game, based on the State design pattern. + * {@link com.gamejolt.mikykr5.ceidecpong.states.BaseState} is the fundamental class of the pattern and must be extended by + * all recognized states in the game. These states define a state machine that is handled by the + * {@link com.gamejolt.mikykr5.ceidecpong.GameCore} as part of the game's life cycle. + */ +package com.gamejolt.mikykr5.ceidecpong.states; diff --git a/core/src/com/gamejolt/mikykr5/ceidecpong/utils/managers/package-info.java b/core/src/com/gamejolt/mikykr5/ceidecpong/utils/managers/package-info.java new file mode 100644 index 0000000..b12bf5f --- /dev/null +++ b/core/src/com/gamejolt/mikykr5/ceidecpong/utils/managers/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2014, Miguel Angel Astor Romero + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Read the LICENSE file for more details. + */ + +/** + * This package contains assorted cached resource managers that can be used by the game to handle specific reusable assets. + */ +package com.gamejolt.mikykr5.ceidecpong.utils.managers; diff --git a/core/src/com/gamejolt/mikykr5/ceidecpong/utils/package-info.java b/core/src/com/gamejolt/mikykr5/ceidecpong/utils/package-info.java new file mode 100644 index 0000000..fcfdc6b --- /dev/null +++ b/core/src/com/gamejolt/mikykr5/ceidecpong/utils/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2014, Miguel Angel Astor Romero + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Read the LICENSE file for more details. + */ + +/** + * This package contains assorted utility classes that can be used by the other parts of the game as needed. + */ +package com.gamejolt.mikykr5.ceidecpong.utils; diff --git a/desktop/src/com/gamejolt/mikykr5/ceidecpong/desktop/package-info.java b/desktop/src/com/gamejolt/mikykr5/ceidecpong/desktop/package-info.java new file mode 100644 index 0000000..0f28ef8 --- /dev/null +++ b/desktop/src/com/gamejolt/mikykr5/ceidecpong/desktop/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2014, Miguel Angel Astor Romero + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Read the LICENSE file for more details. + */ + +/** + * This package contains the desktop initializer of the game, along with any other desktop OS specific classes of the game. + */ +package com.gamejolt.mikykr5.ceidecpong.desktop;