[
https://issues.apache.org/jira/browse/SIS-91?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Martin Desruisseaux updated SIS-91:
-----------------------------------
Description:
The developer guide needs to be expanded with the following items:
* The four levels of documentation: members, types, packages, modules (APT
pages).
* The {{castOrCopy}} methods, found in metadata, referencing, _etc_.
* Convenience constructors in metadata object. Their arguments are the
mandatory properties of the metadata object, and the argument types are often
simpler than the corresponding setter method (singleton, {{CharSequence}}
instead of {{InternationalString}}).
* Policy about {{null}} argument value: often accepted in the following
contexts:
** The value of an optional property. Very common in metadata objects.
** In static method calculating a value from the given argument, without
changing the state of any object. In such case, the value returned by that
method will often be {{null}} as well. This is very similar to {{NaN}} number
in {{java.lang.Math}} functions.
* Unified identifiers view ({{IdentifierMap}}).
was:
The developer guide needs to be expanded with the following items:
* The four levels of documentation: members, types, packages, modules (APT
pages).
* The {{castOrCopy}} methods, found in metadata, referencing, _etc_.
* Convenience constructors in metadata object. Their arguments are the
mandatory properties of the metadata object, and the argument types are often
simpler than the corresponding setter method (singleton, {{CharSequence}}
instead of {{InternationalString}}).
* Policy about {{null}} argument value: often accepted in the following
contexts:
** The value of an optional property. Very common in metadata objects.
** In static method calculating a value from the given argument, without
changing the state of any object. In such case, the value returned by that
method will often be {{null}} as well. This is very similar to {{NaN}} number
in {{java.lang.Math}} functions.
> Addition to the developer guide for metadata
> --------------------------------------------
>
> Key: SIS-91
> URL: https://issues.apache.org/jira/browse/SIS-91
> Project: Spatial Information Systems
> Issue Type: Improvement
> Components: Documentation
> Reporter: Martin Desruisseaux
> Assignee: Martin Desruisseaux
> Priority: Minor
> Fix For: 0.3
>
>
> The developer guide needs to be expanded with the following items:
> * The four levels of documentation: members, types, packages, modules (APT
> pages).
> * The {{castOrCopy}} methods, found in metadata, referencing, _etc_.
> * Convenience constructors in metadata object. Their arguments are the
> mandatory properties of the metadata object, and the argument types are often
> simpler than the corresponding setter method (singleton, {{CharSequence}}
> instead of {{InternationalString}}).
> * Policy about {{null}} argument value: often accepted in the following
> contexts:
> ** The value of an optional property. Very common in metadata objects.
> ** In static method calculating a value from the given argument, without
> changing the state of any object. In such case, the value returned by that
> method will often be {{null}} as well. This is very similar to {{NaN}} number
> in {{java.lang.Math}} functions.
> * Unified identifiers view ({{IdentifierMap}}).
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
