arch-jedi/nx01
1
0
Fork 0
Code Issues Pull requests Actions Packages Releases Activity

Fixed javadoc errors

Browse source
This commit is contained in:
Willem Cazander 2024-12-14 21:06:31 +01:00
parent 930bff82e1
commit a06f6629d6
21 changed files with 49 additions and 63 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -68,11 +68,18 @@ ETA: 2030...to remove ALL, ASCII and unicode on a self hosted platform.
[DEC64](https://www.crockford.com/dec64.html) as the example.(no impl)
- 7HFF = 7of9 Hebrew Fraction Fractal or GroßGetậl(no impl)
## Package
## Maven Use
Run once, to install the maven plugin used in testing
- mvn install -Ptest-none
Make package jar's
- mvn clean package
- result: nx01-jpp-base/target/nx01-jpp-base-〇一。壬寅。一〄-SNAPSHOT.jar (19MB)
Run javadoc;
- mvn -Ptest-none install javadoc:aggregate
## Komputer
Oorspronkelik wodde et Ingelse woord computer bruukt om iene mit an te duden die kompliceerde

20
nx01-popcorn-mm-jdbc/src/main/java/org/eobjects/metamodel/doc/jdbc/DBPrimaryKey.java
View file

@ -43,70 +43,70 @@ public class DBPrimaryKey {
}
/**
* @return the name
* @return the name.
*/
public String getName() {
return name;
}
/**
* @param name the name to set
* @param name the name to set.
*/
public void setName(String name) {
this.name = name;
}
/**
* @return the catalog
* @return the catalog.
*/
public String getCatalog() {
return catalog;
}
/**
* @param catalog the catalog to set
* @param catalog the catalog to set.
*/
public void setCatalog(String catalog) {
this.catalog = catalog;
}
/**
* @return the schema
* @return the schema.
*/
public String getSchema() {
return schema;
}
/**
* @param schema the schema to set
* @param schema the schema to set.
*/
public void setSchema(String schema) {
this.schema = schema;
}
/**
* @return the tableName
* @return the tableName.
*/
public String getTableName() {
return tableName;
}
/**
* @param tableName the tableName to set
* @param tableName the tableName to set.
*/
public void setTableName(String tableName) {
this.tableName = tableName;
}
/**
* @return the columnNames
* @return the columnNames.
*/
public List<String> getColumnNames() {
return columnNames;
}
/**
* @param columnNames the columnNames to set
* @param columnName the columnName to add.
*/
protected void addColumnName(String columnName) {
this.columnNames.add(columnName);

2
nx01-popcorn-mm-jdbc/src/main/java/org/eobjects/metamodel/doc/jdbc/DBTable.java
View file

@ -101,7 +101,7 @@ public class DBTable {
}
/**
* @param index the indexes to add.
* @param column the indexes to add.
*/
public List<DBIndex> getIndexesByColumn(String column) {
List<DBIndex> result = new ArrayList<DBIndex>(3);

4
nx01-x4o-driver/src/main/java/org/x4o/xml/eld/EldModuleLoader.java
View file

@ -75,9 +75,9 @@ public class EldModuleLoader implements X4OLanguageModuleLoader {
/**
* Loads the ELD language into the module.
* @param language The langauge to load for.
* @param elementLanguageModule The module to load it in.
* @param languageModule The module to load it in.
* @throws X4OLanguageModuleLoaderException When eld language could not be loaded.
* @see org.x4o.xml.lang.X4OLanguageModuleLoader#loadLanguageModule(org.x4o.xml.lang.X4OLanguageLocal, org.x4o.xml.lang.X4OLanguageModule)
* @see org.x4o.xml.lang.X4OLanguageModuleLoader#loadLanguageModule(org.x4o.xml.lang.X4OLanguageLocal, org.x4o.xml.lang.X4OLanguageModuleLocal)
*/
public void loadLanguageModule(X4OLanguageLocal language,X4OLanguageModuleLocal languageModule) throws X4OLanguageModuleLoaderException {
logger.fine("Loading name eld file from resource: "+eldResource);

2
nx01-x4o-driver/src/main/java/org/x4o/xml/eld/EldModuleLoaderCore.java
View file

@ -85,7 +85,7 @@ public class EldModuleLoaderCore implements X4OLanguageModuleLoader {
* Loads the CEL language into the module.
* @param language The langauge to load for.
* @param languageModule The module to load it in.
* @see org.x4o.xml.lang.X4OLanguageModuleLoader#loadLanguageModule(org.x4o.xml.lang.X4OLanguageLocal, org.x4o.xml.lang.X4OLanguageModule)
* @see org.x4o.xml.lang.X4OLanguageModuleLoader#loadLanguageModule(org.x4o.xml.lang.X4OLanguageLocal, org.x4o.xml.lang.X4OLanguageModuleLocald)
*/
public void loadLanguageModule(X4OLanguageLocal language,X4OLanguageModuleLocal languageModule) throws X4OLanguageModuleLoaderException {

2
nx01-x4o-driver/src/main/java/org/x4o/xml/element/DefaultElementObjectPropertyValue.java
View file

@ -109,7 +109,6 @@ public class DefaultElementObjectPropertyValue implements ElementObjectPropertyV
* @param object
* @param parameterName
* @param parameter
* @throws ElementParameterException
* @throws ElementObjectPropertyValueException
*/
public void setProperty(Object object,String parameterName,Object parameter) throws ElementObjectPropertyValueException {
@ -242,7 +241,6 @@ public class DefaultElementObjectPropertyValue implements ElementObjectPropertyV
*
* @param object The object to get from.
* @param parameterName The parameter name of the property to get.
* @throws ElementParameterException
* @throws ElementObjectPropertyValueException
*/
public Object getProperty(Object object,String parameterName) throws ElementObjectPropertyValueException {

10
nx01-x4o-driver/src/main/java/org/x4o/xml/element/ElementAttributeValueParser.java
View file

@ -46,8 +46,8 @@ public interface ElementAttributeValueParser {
* @param value The attribute value.
* @param element The element of the attribute.
* @return Returns the resolved el parameter value.
* @throws ElementParameterException
* @throws ElementObjectPropertyValueException
* @throws ElementAttributeValueParserException
* @throws ObjectConverterException
*/
Object getELParameterValue(String value,Element element) throws ElementAttributeValueParserException,ObjectConverterException;
@ -57,7 +57,8 @@ public interface ElementAttributeValueParser {
* @param value The value of the attribute.
* @param element The element of the attribute.
* @return Returns the converted attribute value.
* @throws ElementParameterException
* @throws ElementAttributeValueParserException
* @throws ObjectConverterException
*/
Object getConvertedParameterValue(String name,Object value,Element element) throws ElementAttributeValueParserException,ObjectConverterException;
@ -68,7 +69,8 @@ public interface ElementAttributeValueParser {
* @param value The value of the attribute.
* @param element The element of the attribute.
* @return Returns the attribute value.
* @throws ElementParameterException
* @throws ElementAttributeValueParserException
* @throws ObjectConverterException
*/
Object getParameterValue(String name,String value,Element element) throws ElementAttributeValueParserException,ObjectConverterException;
}

2
nx01-x4o-driver/src/main/java/org/x4o/xml/io/DefaultX4OWriter.java
View file

@ -94,7 +94,7 @@ public class DefaultX4OWriter<T> extends AbstractX4OWriter<T> {
}
/**
* @see org.x4o.xml.lang.X4OLanguageSession#getPropertyConfig()
* @see org.x4o.xml.io.AbstractX4OConnection#getPropertyConfig()
*/
public PropertyConfig getPropertyConfig() {
return propertyConfig;

15
nx01-x4o-driver/src/main/java/org/x4o/xml/io/sax/X4OContentParser.java
View file

@ -178,26 +178,17 @@ public class X4OContentParser {
}
}
/**
* @see org.x4o.xml.lang.X4OLanguageConfiguration#getSAXParserProperties(org.x4o.xml.lang.X4OLanguageSession)
*/
public Map<String, Object> getSAXParserProperties(X4OLanguageSession elementContext) {
Map<String,Object> saxParserProperties = new HashMap<String,Object>(1);
return saxParserProperties;
}
/**
* @see org.x4o.xml.lang.X4OLanguageConfiguration#getSAXParserPropertiesOptional(org.x4o.xml.lang.X4OLanguageSession)
*/
public Map<String, Object> getSAXParserPropertiesOptional(X4OLanguageSession elementContext) {
Map<String,Object> saxParserProperties = new HashMap<String,Object>(1);
saxParserProperties.put("http://apache.org/xml/properties/input-buffer-size",getPropertyConfig().getProperty(DefaultX4OReader.DOC_BUFFER_SIZE)); // Increase buffer to 8KB
return saxParserProperties;
}
/**
* @see org.x4o.xml.lang.X4OLanguageConfiguration#getSAXParserFeatures(org.x4o.xml.lang.X4OLanguageSession)
*/
public Map<String, Boolean> getSAXParserFeatures(X4OLanguageSession elementContext) {
// see example: http://xerces.apache.org/xerces2-j/features.html
@ -244,9 +235,6 @@ public class X4OContentParser {
return saxParserFeatures;
}
/**
* @see org.x4o.xml.lang.X4OLanguageConfiguration#getSAXParserFeaturesOptional(org.x4o.xml.lang.X4OLanguageSession)
*/
public Map<String, Boolean> getSAXParserFeaturesOptional(X4OLanguageSession elementContext) {
Map<String,Boolean> saxParserFeatures = new HashMap<String,Boolean>(20);
@ -268,9 +256,6 @@ public class X4OContentParser {
return saxParserFeatures;
}
/**
* @see org.x4o.xml.lang.X4OLanguageConfiguration#getSAXParserFeaturesRequired(org.x4o.xml.lang.X4OLanguageSession)
*/
public List<String> getSAXParserFeaturesRequired(X4OLanguageSession elementContext) {
List<String> result = new ArrayList<String>(5);
result.add("http://xml.org/sax/features/use-attributes2"); // Attributes objects passed by the parser are ext.Attributes2 interface.

4
nx01-x4o-driver/src/main/java/org/x4o/xml/io/sax/X4ODebugWriter.java
View file

@ -142,10 +142,6 @@ public class X4ODebugWriter {
class DebugX4OPhaseListener implements X4OPhaseListener {
long startTime = 0;
/**
* @throws X4OPhaseException
* @see org.x4o.xml.lang.phase.X4OPhaseListener#preRunPhase(org.x4o.xml.lang.X4OLanguageSession)
*/
public void preRunPhase(X4OPhase phase,X4OLanguageSession elementLanguage) throws X4OPhaseException {
startTime = System.currentTimeMillis();
try {

4
nx01-x4o-driver/src/main/java/org/x4o/xml/io/sax/ext/AbstractContentWriter.java
View file

@ -35,6 +35,10 @@ import org.xml.sax.SAXException;
*/
public abstract class AbstractContentWriter extends AbstractContentWriterLexical implements ContentWriter {
/**
* Creates an Lecical content writer for XML.
* @param out The writer to write to.
*/
public AbstractContentWriter(Writer out) {
super(out);
}

8
nx01-x4o-driver/src/main/java/org/x4o/xml/io/sax/ext/AbstractContentWriterHandler.java
View file

@ -512,6 +512,8 @@ public class AbstractContentWriterHandler implements ContentHandler {
/**
* Escape and prints xml characters.
* @param text The text to write.
* @throws SAXException When IOException has happend while printing.
* @see org.x4o.xml.io.sax.ext.ContentWriter#characters(java.lang.String)
*/
public void characters(String text) throws SAXException {
@ -638,6 +640,8 @@ public class AbstractContentWriterHandler implements ContentHandler {
/**
* Prints xml comment.
*
* @param text The text to write.
* @throws SAXException When IOException has happend while printing.
* @see org.x4o.xml.io.sax.ext.ContentWriter#comment(java.lang.String)
*/
public void comment(String text) throws SAXException {
@ -682,7 +686,7 @@ public class AbstractContentWriterHandler implements ContentHandler {
/**
* Auto close the start element if working in printing event.
* @throws IOException When prints gives exception.
* @throws SAXException When prints gives exception.
*/
protected void autoCloseStartElement() throws SAXException {
if (startElement==null) {
@ -694,7 +698,7 @@ public class AbstractContentWriterHandler implements ContentHandler {
/**
* Indent the output writer with tabs by indent count.
* @throws IOException When prints gives exception.
* @throws SAXException When prints gives exception.
*/
private void writeIndent() throws SAXException {
for (int i = 0; i < indent; i++) {

8
nx01-x4o-driver/src/main/java/org/x4o/xml/lang/AbstractX4OLanguageModule.java
View file

@ -94,7 +94,7 @@ public abstract class AbstractX4OLanguageModule extends AbstractElementMetaBase
}
/**
* @see org.x4o.xml.lang.X4OLanguageModule#addElementBindingHandler(ElementBindingHandler)
* @see org.x4o.xml.lang.X4OLanguageModuleLocal#addElementBindingHandler(ElementBindingHandler)
*/
public void addElementBindingHandler(ElementBindingHandler elementBindingHandler) {
if (elementBindingHandler==null) {
@ -122,7 +122,7 @@ public abstract class AbstractX4OLanguageModule extends AbstractElementMetaBase
}
/**
* @see org.x4o.xml.lang.X4OLanguageModule#addElementConfiguratorGlobal(ElementConfiguratorGlobal)
* @see org.x4o.xml.lang.X4OLanguageModuleLocal#addElementConfiguratorGlobal(ElementConfiguratorGlobal)
*/
public void addElementConfiguratorGlobal(ElementConfiguratorGlobal elementConfigurator) {
if (elementConfigurator==null) {
@ -143,7 +143,7 @@ public abstract class AbstractX4OLanguageModule extends AbstractElementMetaBase
}
/**
* @see org.x4o.xml.lang.X4OLanguageModule#addElementInterface(org.x4o.xml.element.ElementInterface)
* @see org.x4o.xml.lang.X4OLanguageModuleLocal#addElementInterface(org.x4o.xml.element.ElementInterface)
*/
public void addElementInterface(ElementInterface elementInterface) {
if (elementInterface==null) {
@ -166,7 +166,7 @@ public abstract class AbstractX4OLanguageModule extends AbstractElementMetaBase
}
/**
* @see org.x4o.xml.lang.X4OLanguageModule#addElementNamespace(org.x4o.xml.element.ElementNamespace)
* @see org.x4o.xml.lang.X4OLanguageModuleLocal#addElementNamespace(org.x4o.xml.element.ElementNamespace)
*/
public void addElementNamespace(ElementNamespace elementNamespace) {
if (elementNamespace==null) {

3
nx01-x4o-driver/src/main/java/org/x4o/xml/lang/DefaultX4OLanguage.java
View file

@ -128,8 +128,7 @@ public class DefaultX4OLanguage implements X4OLanguageLocal {
}
/**
* @throws X4OPhaseException
* @see org.x4o.xml.lang.X4OLanguage#createLanguageContext(org.x4o.xml.X4ODriver)
* @see org.x4o.xml.lang.X4OLanguage#createLanguageSession()
*/
public X4OLanguageSession createLanguageSession() {
X4OLanguageSession result = buildElementLanguage(new DefaultX4OLanguageSession(this));

2
nx01-x4o-driver/src/main/java/org/x4o/xml/lang/DefaultX4OLanguageLoader.java
View file

@ -61,7 +61,7 @@ public class DefaultX4OLanguageLoader implements X4OLanguageLoader {
/**
* Write log message to debug writer.
* @param elementLanguage The elementLanguage we are loading.
* @param language The X4O language we are loading.
* @param message The message to log to the debug output.
*/
private void logMessage(X4OLanguage language,String message) {

4
nx01-x4o-driver/src/main/java/org/x4o/xml/lang/phase/X4OPhaseListener.java
View file

@ -37,7 +37,7 @@ public interface X4OPhaseListener {
/**
* Gets called before the X4OPhaseHandler is run.
* @param phase The phase to be run.
* @param elementLanguage The elementLanguage of the driver.
* @param languageSession The X4O language session of the driver.
* @throws X4OPhaseException Is throws when listeners has error.
*/
void preRunPhase(X4OPhase phase,X4OLanguageSession languageSession) throws X4OPhaseException;
@ -45,7 +45,7 @@ public interface X4OPhaseListener {
/**
* Gets called after the X4OPhaseHandler is runned.
* @param phase The phase just run.
* @param elementLanguage The elementLanguage of the driver.
* @param languageSession The X4O language session of the driver.
* @throws X4OPhaseException Is throws when listeners has error.
*/
void endRunPhase(X4OPhase phase,X4OLanguageSession languageSession) throws X4OPhaseException;

7
nx01-x4o-driver/src/main/java/org/x4o/xml/lang/task/AbstractX4OLanguageTask.java
View file

@ -105,11 +105,4 @@ public abstract class AbstractX4OLanguageTask implements X4OLanguageTask {
public String getDescription() {
return description;
}
/**
* @see org.x4o.xml.lang.task.X4OLanguageTask#getTaskConfig()
*/
public PropertyConfig getTaskConfig() {
return propertyConfig;
}
}

1
nx01-x4o-eld-doc/src/main/java/org/x4o/xml/eld/doc/EldDocWriter.java
View file

@ -136,7 +136,6 @@ public class EldDocWriter {
/**
* Writes the language documentation to the base path.
* @param basePath The path to write to documentation to.
* @throws ElementException Is thrown when error is done.
*/
public void writeDocumentation() throws ElementException {

1
nx01-x4o-eld-doc/src/main/java/org/x4o/xml/eld/doc/api/ApiDocWriter.java
View file

@ -121,7 +121,6 @@ public class ApiDocWriter {
/**
* Writes the language documentation to the base path.
* @param basePath The path to write to documentation to.
* @throws ElementException Is thrown when error is done.
*/
public void writeDocumentation() throws ElementException {

2
nx01-x4o-eld-doc/src/main/java/org/x4o/xml/eld/doc/api/dom/ApiDocWriteEvent.java
View file

@ -40,7 +40,7 @@ public class ApiDocWriteEvent<T> {
* Creates an ApiDocNodeBodyEvent.
* @param doc The ApiDoc we are writing.
* @param writer The content writer to write to.
* @param event The event we are firing this event for.
* @param eventObject The event we are firing this event for.
*/
public ApiDocWriteEvent(ApiDoc doc,ApiDocContentWriter writer,T eventObject) {
this.doc=doc;

2
nx01-x4o-meta/src/main/java/org/x4o/xml/lang/meta/MetaLanguageSiblingLoader.java
View file

@ -54,7 +54,7 @@ public class MetaLanguageSiblingLoader implements X4OLanguageModuleLoaderSibling
* @param language The ElementLanguage to load for.
* @param languageModule The ElementLanguageModule to load into.
* @throws X4OLanguageModuleLoaderException Is thrown when meta language could not be loaded.
* @see org.x4o.xml.lang.X4OLanguageModuleLoader#loadLanguageModule(org.x4o.xml.lang.X4OLanguageLocal, org.x4o.xml.lang.X4OLanguageModule)
* @see org.x4o.xml.lang.X4OLanguageModuleLoader#loadLanguageModule(org.x4o.xml.lang.X4OLanguageLocal, org.x4o.xml.lang.X4OLanguageModuleLocal)
*/
public void loadLanguageModule(X4OLanguageLocal language,X4OLanguageModuleLocal languageModule) throws X4OLanguageModuleLoaderException {
languageModule.setId(META_LANGUAGE);