33 lines
632 B
Plaintext
33 lines
632 B
Plaintext
== Why is this an issue?
|
|
|
|
Each package in a Java project should include a ``++package-info.java++`` file. The purpose of this file is to document the Java package using javadoc and declare package annotations.
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
/**
|
|
* This package has non null parameters and is documented.
|
|
**/
|
|
@ParametersAreNonnullByDefault
|
|
package org.foo.bar;
|
|
----
|
|
|
|
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::message.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::comments-and-links.adoc[]
|
|
endif::env-github,rspecator-view[]
|