Skip to content
This repository was archived by the owner on Dec 23, 2023. It is now read-only.

Commit 1768773

Browse files
committed
Improves Javadoc formatting.
1 parent 168c3cc commit 1768773

File tree

5 files changed

+16
-11
lines changed

5 files changed

+16
-11
lines changed

core/java/com/google/census/Census.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,10 @@ public static CensusContext getCurrent() {
4242
}
4343

4444
/**
45-
* Creates a {@link CensusContext} from the given on-the-wire encoded representation. Should be
46-
* the inverse of {@link CensusContext#serialize()}. The serialized representation should be
47-
* based on the {@link CensusContext} protobuf representation.
45+
* Creates a {@link CensusContext} from the given on-the-wire encoded representation.
46+
*
47+
* <p>Should be the inverse of {@link CensusContext#serialize()}. The serialized representation
48+
* should be based on the {@link CensusContext} protobuf representation.
4849
*/
4950
@Nullable
5051
public static CensusContext deserialize(ByteBuffer buffer) {

core/java/com/google/census/CensusContext.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ public final CensusContext with(
4848

4949
/**
5050
* Serializes the {@link CensusContext} into the on-the-wire representation.
51-
* The inverse of {@link CensusContextFactory#deserialize()} and should be based on the
51+
*
52+
* <p>The inverse of {@link CensusContextFactory#deserialize()} and should be based on the
5253
* {@link CensusContext} protobuf representation.
5354
*
5455
* @return serialized bytes.

core/java/com/google/census/CensusContextFactory.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,10 @@
2121
*/
2222
public abstract class CensusContextFactory {
2323
/**
24-
* Creates a {@link CensusContext} from the given on-the-wire encoded representation. Should be
25-
* the inverse of {@link CensusContext#serialize()}. The serialized representation should be
26-
* based on the {@link CensusContext} protobuf representation.
24+
* Creates a {@link CensusContext} from the given on-the-wire encoded representation.
25+
*
26+
* <p>Should be the inverse of {@link CensusContext#serialize()}. The serialized representation
27+
* should be based on the {@link CensusContext} protobuf representation.
2728
*
2829
* @param buffer on-the-wire representation of a {@link CensusContext}
2930
* @return a {@link CensusContext} deserialized from {@code buffer}

core_native/java/com/google/census/CensusContextFactoryImpl.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,9 @@ final class CensusContextFactoryImpl extends CensusContextFactory {
2222
static final CensusContextImpl DEFAULT = new CensusContextImpl(new HashMap<String, String>(0));
2323

2424
/**
25-
* Deserializes a {@link CensusContextImpl} from a serialized {@link CensusContextProto}. The
26-
* encoded tags are of the form: (<tag prefix> + 'key' + <tag delim> + 'value')*
25+
* Deserializes a {@link CensusContextImpl} from a serialized {@link CensusContextProto}.
26+
*
27+
* <p>The encoded tags are of the form: {@code <tag prefix> + 'key' + <tag delim> + 'value'}*
2728
*/
2829
@Override
2930
@Nullable

core_native/java/com/google/census/CensusContextImpl.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,9 @@ public CensusContextImpl record(MetricMap stats) {
3535
}
3636

3737
/**
38-
* Serializes a {@link CensusContextImpl} into {@link CensusContextProto} serialized format. The
39-
* encoded tags are of the form: (<tag prefix> + 'key' + <tag delim> + 'value')*
38+
* Serializes a {@link CensusContextImpl} into {@link CensusContextProto} serialized format.
39+
*
40+
* <p>The encoded tags are of the form: {@code <tag prefix> + 'key' + <tag delim> + 'value'}*
4041
*/
4142
@Override
4243
public ByteBuffer serialize() {

0 commit comments

Comments
 (0)