rusefi
/
java-intelhex-parser
mirror of https://github.com/rusefi/java-intelhex-parser.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Resolve #3 javadoc warnings

This commit is contained in:
Jan Breuer 2015-10-01 13:50:30 +02:00
parent b53fb20281
commit 01f5c61d4d
10 changed files with 21 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
dist/README.TXT vendored
View File

@ -1,32 +0,0 @@
========================
BUILD OUTPUT DESCRIPTION
========================
When you build an Java application project that has a main class, the IDE
automatically copies all of the JAR
files on the projects classpath to your projects dist/lib folder. The IDE
also adds each of the JAR files to the Class-Path element in the application
JAR files manifest file (MANIFEST.MF).
To run the project from the command line, go to the dist folder and
type the following:
java -jar "IntelHexParser.jar"
To distribute this project, zip up the dist folder (including the lib folder)
and distribute the ZIP file.
Notes:
* If two JAR files on the project classpath have the same name, only the first
JAR file is copied to the lib folder.
* Only JAR files are copied to the lib folder.
If the classpath contains other types of files or folders, these files (folders)
are not copied.
* If a library on the projects classpath also has a Class-Path element
specified in the manifest,the content of the Class-Path element has to be on
the projects runtime path.
* To set a main class in a standard Java project, right-click the project node
in the Projects window and choose Properties. Then click Run and enter the
class name in the Main Class field. Alternatively, you can manually type the
class name in the manifest Main-Class element.

3
src/cz/jaybee/intelhex/BinWriter.java
View File

@ -1,5 +1,5 @@
/**
* @license Copyright (c) 2015, Jan Breuer All rights reserved.
* Copyright (c) 2015, Jan Breuer All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@ -35,7 +35,6 @@ import java.util.logging.Logger;
* Binary file writer
*
* @author Jan Breuer
* @license BSD 2-Clause
*/
public class BinWriter implements IntelHexDataListener {

3
src/cz/jaybee/intelhex/IntelHexDataListener.java
View File

@ -1,5 +1,5 @@
/**
* @license Copyright (c) 2015, Jan Breuer All rights reserved.
* Copyright (c) 2015, Jan Breuer All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@ -29,7 +29,6 @@ package cz.jaybee.intelhex;
* Listener interface to parser events
*
* @author Jan Breuer
* @license BSD 2-Clause
*/
public interface IntelHexDataListener {

3
src/cz/jaybee/intelhex/IntelHexException.java
View File

@ -1,5 +1,5 @@
/**
* @license Copyright (c) 2015, Jan Breuer All rights reserved.
* Copyright (c) 2015, Jan Breuer All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@ -29,7 +29,6 @@ package cz.jaybee.intelhex;
* Custom exception to prevent using general Exception
*
* @author Jan Breuer
* @license BSD 2-Clause
*/
public class IntelHexException extends Exception {

9
src/cz/jaybee/intelhex/IntelHexParser.java
View File

@ -1,5 +1,5 @@
/**
* @license Copyright (c) 2015, Jan Breuer All rights reserved.
* Copyright (c) 2015, Jan Breuer All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@ -33,7 +33,6 @@ import java.io.*;
* @author Jan Breuer
* @author Kristian Sloth Lauszus
* @author riilabs
* @license BSD 2-Clause
*/
public class IntelHexParser {
@ -108,8 +107,8 @@ public class IntelHexParser {
/**
* Parse one line of Intel HEX file
*
* @param record
* @return
* @param string record
* @return parsed record
* @throws IntelHexException
*/
private Record parseRecord(String record) throws IntelHexException {
@ -230,7 +229,7 @@ public class IntelHexParser {
* Return program start address/reset address. May not be at the beggining
* of the data.
*
* @return
* @return Start address
*/
public long getStartAddress() {
return startAddress;

3
src/cz/jaybee/intelhex/IntelHexParserDemo.java
View File

@ -1,5 +1,5 @@
/**
* @license Copyright (c) 2015, Jan Breuer All rights reserved.
* Copyright (c) 2015, Jan Breuer All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@ -36,7 +36,6 @@ import java.util.logging.Logger;
* Class to demonstrate usage of Intel HEX parser
*
* @author Jan Breuer
* @license BSD 2-Clause
*/
public class IntelHexParserDemo {

9
src/cz/jaybee/intelhex/IntelHexRecordType.java
View File

@ -1,5 +1,5 @@
/**
* @license Copyright (c) 2015, Jan Breuer All rights reserved.
* Copyright (c) 2015, Jan Breuer All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@ -29,7 +29,6 @@ package cz.jaybee.intelhex;
* Type of one record in Intel HEX file (type of line)
*
* @author Jan Breuer
* @license BSD 2-Clause
*/
public enum IntelHexRecordType {
@ -49,7 +48,7 @@ public enum IntelHexRecordType {
/**
* Convert enum value to integer
*
* @return
* @return record type integer value
*/
public int toInt() {
return id;
@ -58,8 +57,8 @@ public enum IntelHexRecordType {
/**
* Convert integer value to enum value
*
* @param id
* @return
* @param id record type integer value
* @return record type enum value
*/
public static IntelHexRecordType fromInt(int id) {
for (IntelHexRecordType d : IntelHexRecordType.values()) {

3
src/cz/jaybee/intelhex/MemoryRegions.java
View File

@ -1,5 +1,5 @@
/**
* @license Copyright (c) 2015, Jan Breuer All rights reserved.
* Copyright (c) 2015, Jan Breuer All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@ -35,7 +35,6 @@ import java.util.List;
*
* @author Jan Breuer
* @author riilabs
* @license BSD 2-Clause
*/
public class MemoryRegions {

3
src/cz/jaybee/intelhex/RangeDetector.java
View File

@ -1,5 +1,5 @@
/**
* @license Copyright (c) 2015, Jan Breuer All rights reserved.
* Copyright (c) 2015, Jan Breuer All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@ -30,7 +30,6 @@ package cz.jaybee.intelhex;
*
* @author riilabs
* @author Jan Breuer
* @license BSD 2-Clause
*/
public class RangeDetector implements IntelHexDataListener {

14
src/cz/jaybee/intelhex/Region.java
View File

@ -1,5 +1,5 @@
/**
* @license Copyright (c) 2015, Jan Breuer All rights reserved.
* Copyright (c) 2015, Jan Breuer All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@ -29,7 +29,6 @@ package cz.jaybee.intelhex;
* One memory region
*
* @author Jan Breuer
* @license BSD 2-Clause
*/
public class Region implements Comparable<Region> {
@ -43,7 +42,7 @@ public class Region implements Comparable<Region> {
/**
* Get length of the region
* @return
* @return length of the region
*/
public long getLength() {
return addressEnd - addressStart + 1;
@ -51,7 +50,7 @@ public class Region implements Comparable<Region> {
/**
* Return last address in memory region
* @return
* @return last address in memory region
*/
public long getAddressEnd() {
return addressEnd;
@ -67,7 +66,7 @@ public class Region implements Comparable<Region> {
/**
* Get start address of the region
* @return
* @return start address of memory region
*/
public long getAddressStart() {
return addressStart;
@ -97,8 +96,9 @@ public class Region implements Comparable<Region> {
/**
* Compare, if one region is after another region
*
* @param o
* @return
* @param o the object to be compared.
* @return a negative integer, zero, or a positive integer as this object
* is less than, equal to, or greater than the specified object.
*/
@Override
public int compareTo(Region o) {