Skip to content

Commit fd279c8

Browse files
SergixSergix
committed
Source Comments
View changelog entry Sergix#85 for details.
1 parent 3693e44 commit fd279c8

File tree

22 files changed

+103
-70
lines changed

22 files changed

+103
-70
lines changed

‎.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,5 @@ target/maven-status/maven-compiler-plugin/testCompile/default-testCompile/inputF
3030
target/
3131
*.lst
3232

33-
*.class
33+
*.class
34+
target/classes/main/java/jterm/Client.class

‎README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
[![JTerm](https://sergix.github.io/img/jterm.png)](https://sergix.github.io/projects/jterm/index.html)
22

33
![Build Status](https://travis-ci.org/Sergix/JTerm.svg?branch=master)
4-
[![Code Triagers Badge](https://www.codetriage.com/sergix/jterm/badges/users.svg)](https://www.codetriage.com/sergix/jterm)
4+
[![Code Triagers Badge](https://www.codetriage.com/sergix/jterm/badges/users.svg)](https://www.codetriage.com/sergix/jterm)
5+
6+
[![Stories in Ready](https://badge.waffle.io/Sergix/JTerm.svg?label=ready&title=Ready)](http://waffle.io/Sergix/JTerm)
57

68
## What is it?
79
A terminal written for cross-platform usage.

‎changelog.txt

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
(#85)[9/17/2017-18:07 0.5.1 Sergix]
2+
Updated documentation comments in the source code.
3+
Removed the Process() function from Window and Exec.
4+
Pushed updates to Git.
5+
16
(#84)[9/12/2017-21:26 0.5.1 Sergix]
27
Wrote patch notes and changelog for version "0.5.1".
38
Compiled binaries and source code, as well as the wrapfile (which may be deprecated).

‎init.bat

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
@echo off
22
cls
33

4-
set JTERM_VERSION=0.5.1
4+
set JTERM_VERSION=0.5.2
55

66
prompt dev~JTerm/

‎pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
<groupId>sergix</groupId>
77
<artifactId>jterm</artifactId>
8-
<version>0.5.1</version>
8+
<version>0.5.2</version>
99
<packaging>jar</packaging>
1010
<description>JTerm is a cross-platform terminal designed for simple use and to run batch files. JTerm is hosted on GitHub by Sergix and NCSGeek.</description>
1111

‎src/main/java/jterm/Dir.java

+16-13
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,15 @@ public class Dir
2828
* Dir() void
2929
*
3030
* Constructor for calling methods.
31+
*
32+
* ArrayList<String> options - command options
3133
*/
3234
public Dir(ArrayList<String> options) { }
3335

3436
/*
3537
* Process() void
3638
*
37-
* Process the input.
39+
* Display help information.
3840
*
3941
* ArrayList<String> options - command options
4042
*/
@@ -59,7 +61,7 @@ public static void Process(ArrayList<String> options)
5961
* and directory names
6062
* -h
6163
* Prints help information
62-
* directory
64+
* directory [...]
6365
* Prints this directory rather than the
6466
* current working directory.
6567
*
@@ -110,7 +112,6 @@ else if (option.equals("-h"))
110112
* Example:
111113
* F RW myfile.txt 5 KB
112114
*/
113-
114115
System.out.println("[Contents of \"" + path + "\"]");
115116
for (File file: files)
116117
{
@@ -130,13 +131,13 @@ else if (option.equals("-h"))
130131
*
131132
* Changes the working directory to the specified
132133
* input.
133-
*
134+
*
135+
* ArrayList<String> options - command options
136+
*
134137
* -h
135138
* Prints help information
136-
* directory
139+
* directory [...]
137140
* Path to change the working directory to.
138-
*
139-
* ArrayList<String> options - command options
140141
*/
141142
public static void Cd(ArrayList<String> options)
142143
{
@@ -216,11 +217,11 @@ public static void Chdir(ArrayList<String> options)
216217
* Pwd() void
217218
*
218219
* Prints the working directory to the console.
219-
*
220-
* -h
221-
* Prints help information
222220
*
223221
* ArrayList<String> options - command options
222+
*
223+
* -h
224+
* Prints help information
224225
*/
225226
public static void Pwd(ArrayList<String> options)
226227
{
@@ -245,11 +246,13 @@ public static void Pwd(ArrayList<String> options)
245246
* Md() void
246247
*
247248
* Creates a new directory.
248-
*
249-
* -h
250-
* Prints help information
251249
*
252250
* ArrayList<String> options - command options
251+
*
252+
* -h
253+
* Prints help information
254+
* name [...]
255+
* Name of the new directory
253256
*/
254257
public static void Md(ArrayList<String> options)
255258
{

‎src/main/java/jterm/Echo.java

+8-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,14 @@ public class Echo
2626
/*
2727
* Echo() void
2828
*
29-
* Constructor for calling Process() function.
29+
* Echo the input to the terminal.
30+
*
31+
* ArrayList<String> options - command options
32+
*
33+
* -h
34+
* Prints help information
35+
* input
36+
* Text to output
3037
*/
3138
public Echo(ArrayList<String> options)
3239
{

‎src/main/java/jterm/Exec.java

+9-13
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,12 @@ public class Exec
2626
/*
2727
* Exec() void
2828
*
29-
* Constructor for calling Process() function.
29+
* Constructor for calling Run() function.
3030
*/
31-
public Exec(ArrayList<String> options) { }
32-
33-
/*
34-
* Process() void
35-
*
36-
* Process the input.
37-
*
38-
* ArrayList<String> options - command options
39-
*/
40-
public static void Process(ArrayList<String> options)
31+
public Exec(ArrayList<String> options)
4132
{
42-
43-
// Default to Run(); nothing to process
33+
34+
// Default to Run()
4435
Run(options);
4536

4637
}
@@ -51,6 +42,11 @@ public static void Process(ArrayList<String> options)
5142
* Runs the executable file.
5243
*
5344
* ArrayList<String> options - command options
45+
*
46+
* -h
47+
* Prints help information
48+
* file
49+
* File to execute
5450
*/
5551
public static boolean Run(ArrayList<String> options)
5652
{

‎src/main/java/jterm/Exit.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ public class Exit
2626
/*
2727
* Exit() void
2828
*
29-
* Constructor for calling Process() function.
29+
* Exits the application.
30+
*
31+
* ArrayList<String> options - command options
3032
*/
3133
public Exit(ArrayList<String> options) {
3234

‎src/main/java/jterm/Files.java

+12-4
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ public class Files
2929
/*
3030
* Files() void
3131
*
32-
* Constructor for calling Process() function.
32+
* Constructor for calling methods.
33+
*
34+
* ArrayList<String> options - command options
3335
*/
3436
public Files(ArrayList<String> options) { }
3537

@@ -56,7 +58,9 @@ public static void Process(String options)
5658
* ArrayList<String> options - command options
5759
*
5860
* -h
59-
* Prints help information
61+
* Prints help information
62+
* filename [...]
63+
* File to write to
6064
*/
6165
public static void Write(ArrayList<String> options)
6266
{
@@ -126,7 +130,9 @@ else if (line.equals(" "))
126130
* ArrayList<String> options - command options
127131
*
128132
* -h
129-
* Prints help information
133+
* Prints help information
134+
* file [...]
135+
* File to delete
130136
*/
131137
public static void Delete(ArrayList<String> options)
132138
{
@@ -199,7 +205,9 @@ public static void Del(ArrayList<String> options)
199205
* ArrayList<String> options - command options
200206
*
201207
* -h
202-
* Prints help information
208+
* Prints help information
209+
* filename [...]
210+
* Prints the contents of the specified files
203211
*
204212
* Credit to @d4nntheman
205213
*/

‎src/main/java/jterm/Help.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public class Help
2626
/*
2727
* Help() void
2828
*
29-
* Constructor for calling Process() function.
29+
* Prints help information.
3030
*/
3131
public Help(ArrayList<String> options)
3232
{

‎src/main/java/jterm/Pause.java

+7-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@ public class Pause
99
/*
1010
* Pause() void
1111
*
12-
* Constructor for calling Process() function.
12+
* Pauses the interpreter until the user
13+
* hits the "Enter" key.
14+
*
15+
* ArrayList<String> options - command options
16+
*
17+
* message
18+
* Pause message to be printed
1319
*/
1420
public Pause(ArrayList<String> options) {
1521

‎src/main/java/jterm/Ping.java

+10-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,16 @@ public class Ping
1616
/*
1717
* Ping() void
1818
*
19-
* Constructor for calling Process() function.
19+
* Pings the specified host.
20+
*
21+
* ArrayList<String> options - command options
22+
23+
* -h
24+
* Prints help information
25+
* host
26+
* Host to ping
27+
* -p port
28+
* Port to ping the host on
2029
*/
2130
public Ping(ArrayList<String> options)
2231
{

‎src/main/java/jterm/Ps.java

+7-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,13 @@ public class Ps
1717
/*
1818
* Ps() void
1919
*
20-
* Constructor for calling Process() function.
20+
* Prints a list of process running on
21+
* the system.
22+
*
23+
* ArrayList<String> options - command options
24+
*
25+
* -h
26+
* Prints help information
2127
*/
2228
public Ps(ArrayList<String> options)
2329
{

‎src/main/java/jterm/Set.java

+4-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@ public class Set
2929
/*
3030
* Set() void
3131
*
32-
* Constructor for calling Process() function.
32+
* Creates a new variable or prints all
33+
* stored variables.
34+
*
35+
* ArrayList<String> options - command options
3336
*/
3437
public Set(ArrayList<String> options)
3538
{

‎src/main/java/jterm/Window.java

-15
Original file line numberDiff line numberDiff line change
@@ -32,21 +32,6 @@ public class Window
3232
private String title = null;
3333
private boolean visible = false;
3434

35-
/*
36-
* Process() void
37-
*
38-
* Process the input.
39-
*
40-
* ArrayList<String> options - command options
41-
*/
42-
public static void Process(ArrayList<String> options)
43-
{
44-
45-
// Default to Window(); nothing to process
46-
new Window(options);
47-
48-
}
49-
5035
/*
5136
* Window() void
5237
*

‎target/classes/main/java/jterm/Dir.class

172 Bytes
Binary file not shown.

‎target/classes/main/java/jterm/Echo.class

88 Bytes
Binary file not shown.

‎target/classes/main/java/jterm/Exec.class

4 Bytes
Binary file not shown.

‎target/classes/main/java/jterm/Files.class

124 Bytes
Binary file not shown.

‎target/classes/main/java/jterm/Window.class

9 Bytes
Binary file not shown.

‎target/maven-status/maven-compiler-plugin/compile/default-compile/inputFiles.lst

+14-14
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
c:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Exit.java
2-
c:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Echo.java
3-
c:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Pause.java
4-
c:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Exec.java
5-
c:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Help.java
6-
c:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Dir.java
7-
c:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Window.java
8-
c:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Server.java
9-
c:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Ping.java
10-
c:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Client.java
11-
c:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Files.java
12-
c:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Ps.java
13-
c:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\JTerm.java
14-
c:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Set.java
1+
C:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Exit.java
2+
C:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Echo.java
3+
C:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Pause.java
4+
C:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Exec.java
5+
C:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Help.java
6+
C:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Dir.java
7+
C:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Window.java
8+
C:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Server.java
9+
C:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Ping.java
10+
C:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Client.java
11+
C:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Files.java
12+
C:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Ps.java
13+
C:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\JTerm.java
14+
C:\Users\Sergi\Development\GitHub\JTerm\src\main\java\jterm\Set.java

0 commit comments

Comments
 (0)