WallyHackenslacker/CEIDEC-Pong
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Added package-info documentation for all packages.

Browse Source
This commit is contained in:
Wally Hackenslacker
2014-10-24 09:55:03 -04:30
parent 5c7fa9da3d
commit d033f73a11
12 changed files with 249 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
android/src/com/gamejolt/mikykr5/ceidecpong/android/package-info.java Normal file
View File

@@ -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;

21
core/src/com/gamejolt/mikykr5/ceidecpong/ecs/components/package-info.java Normal file
View File

@@ -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;

23
core/src/com/gamejolt/mikykr5/ceidecpong/ecs/entities/package-info.java Normal file
View File

@@ -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;

21
core/src/com/gamejolt/mikykr5/ceidecpong/ecs/systems/messaging/package-info.java Normal file
View File

@@ -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;

20
core/src/com/gamejolt/mikykr5/ceidecpong/ecs/systems/package-info.java Normal file
View File

@@ -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;

20
core/src/com/gamejolt/mikykr5/ceidecpong/effects/package-info.java Normal file
View File

@@ -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;

20
core/src/com/gamejolt/mikykr5/ceidecpong/interfaces/package-info.java Normal file
View File

@@ -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;

21
core/src/com/gamejolt/mikykr5/ceidecpong/package-info.java Normal file
View File

@@ -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;

23
core/src/com/gamejolt/mikykr5/ceidecpong/states/package-info.java Normal file
View File

@@ -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;

20
core/src/com/gamejolt/mikykr5/ceidecpong/utils/managers/package-info.java Normal file
View File

@@ -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;

20
core/src/com/gamejolt/mikykr5/ceidecpong/utils/package-info.java Normal file
View File

@@ -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;

20
desktop/src/com/gamejolt/mikykr5/ceidecpong/desktop/package-info.java Normal file
View File

@@ -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;