Skip to content

Fix broken code elements in docs #4292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 8, 2022
Merged

Fix broken code elements in docs #4292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3e8fceb
Fix code blocks
daymxn Nov 8, 2022
88505cd
Fix linting in firebase-database
daymxn Nov 8, 2022
84ed563
Fix FirebaseMLDownloader linting
daymxn Nov 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions firebase-database/src/main/java/com/google/firebase/database/DataSnapshot.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ public Object getValue(boolean useExportFormat) {
*
* An example class might look like:
*
* <pre><code>
* <pre>
* class Message {
* private String author;
* private String text;
Expand All @@ -190,7 +190,7 @@ public Object getValue(boolean useExportFormat) {
*
* // Later
* Message m = snapshot.getValue(Message.class);
* </code></pre>
* </pre>
*
* @param valueType The class into which this snapshot should be marshalled
* @param <T> The type to return. Implicitly defined from the class passed in
Expand All @@ -208,10 +208,10 @@ public <T> T getValue(@NonNull Class<T> valueType) {
* properly-typed Collection. So, in the case where you want a {@link java.util.List} of Message
* instances, you will need to do something like the following:
*
* <pre><code>
* <pre>
* GenericTypeIndicator&lt;List&lt;Message&gt;&gt; t = new GenericTypeIndicator&lt;List&lt;Message&gt;&gt;() {};
* List&lt;Message&gt; messages = snapshot.getValue(t);
* </code></pre>
* </pre>
*
* It is important to use a subclass of {@link GenericTypeIndicator}. See {@link
* GenericTypeIndicator} for more details
Expand Down Expand Up @@ -255,11 +255,13 @@ public String getKey() {

/**
* Gives access to all of the immediate children of this snapshot. Can be used in native for
* loops: <code>
* <br> for (DataSnapshot child : parent.getChildren()) {
* <br> &nbsp;&nbsp;&nbsp;&nbsp;...
* <br> }
* </code>
* loops:
*
* <pre>
* for (DataSnapshot child : parent.getChildren()) {
* &nbsp;&nbsp;&nbsp;&nbsp;...
* }
* </pre>
*
* @return The immediate children of this snapshot
*/
Expand Down
4 changes: 2 additions & 2 deletions firebase-database/src/main/java/com/google/firebase/database/GenericTypeIndicator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
* {@link DataSnapshot}: <br>
* <br>
*
* <pre><code>
* <pre>
* class Message {
* private String author;
* private String text;
Expand All @@ -51,7 +51,7 @@
* GenericTypeIndicator&lt;List&lt;Message&gt;&gt; t = new GenericTypeIndicator&lt;List&lt;Message&gt;&gt;() {};
* List&lt;Message&gt; messages = snapshot.getValue(t);
*
* </code></pre>
* </pre>
*
* @param <T> The type of generic collection that this instance servers as an indicator for
*/
Expand Down
20 changes: 11 additions & 9 deletions firebase-database/src/main/java/com/google/firebase/database/MutableData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,13 @@ public long getChildrenCount() {
}

/**
* Used to iterate over the immediate children at this location <code>
* <br>for (MutableData child : parent.getChildren()) {
* <br>&nbsp;&nbsp;&nbsp;&nbsp;...
* <br>}
* </code>
* Used to iterate over the immediate children at this location
*
* <pre>
* for (MutableData child : parent.getChildren()) {
* &nbsp;&nbsp;&nbsp;&nbsp;...
* }
* </pre>
*
* @return The immediate children at this location
*/
Expand Down Expand Up @@ -196,7 +198,7 @@ public Object getValue() {
*
* An example class might look like:
*
* <pre><code>
* <pre>
* class Message {
* private String author;
* private String text;
Expand All @@ -220,7 +222,7 @@ public Object getValue() {
*
* // Later
* Message m = mutableData.getValue(Message.class);
* </code></pre>
* </pre>
*
* @param valueType The class into which this data in this instance should be marshalled
* @param <T> The type to return. Implicitly defined from the class passed in
Expand All @@ -238,11 +240,11 @@ public <T> T getValue(@NonNull Class<T> valueType) {
* properly-typed Collection. So, in the case where you want a {@link java.util.List} of Message
* instances, you will need to do something like the following:
*
* <pre><code>
* <pre>
* GenericTypeIndicator&lt;List&lt;Message&gt;&gt; t =
* new GenericTypeIndicator&lt;List&lt;Message&gt;&gt;() {};
* List&lt;Message&gt; messages = mutableData.getValue(t);
* </code></pre>
* </pre>
*
* It is important to use a subclass of {@link GenericTypeIndicator}. See {@link
* GenericTypeIndicator} for more details
Expand Down