16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
38 lines
764 B
Plaintext
38 lines
764 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)
|
|
|
|
=== Message
|
|
|
|
Add a 'package-info.java' file to document the 'xxxx' package
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
=== on 4 Sep 2013, 08:43:51 Freddy Mallet wrote:
|
|
Is implemented by \http://jira.codehaus.org/browse/SONARJAVA-325
|
|
|
|
endif::env-github,rspecator-view[]
|