Skip to content

Commit 05ceaff

Browse files
authored
[Crashlytics] Improve documentation clarity (#8368)
Replaced "e.g." and "i.e." with "for example" and "that is" throughout the documentation comments to improve readability and style. NO_RELEASE_CHANGE
1 parent 92a9186 commit 05ceaff

5 files changed

Lines changed: 6 additions & 6 deletions

File tree

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/internal/common/IdManager.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,15 +228,15 @@ public String getAppIdentifier() {
228228

229229
/**
230230
* @return {@link String} identifying the display version of the Android OS that the device is
231-
* running, e.g. "4.2.2". Any forward slashes in the system returned value will be removed.
231+
* running, for example "4.2.2". Any forward slashes in the system returned value will be removed.
232232
*/
233233
public String getOsDisplayVersionString() {
234234
return removeForwardSlashesIn(Build.VERSION.RELEASE);
235235
}
236236

237237
/**
238238
* @return {@link String} identifying the build version of the Android OS that the device is
239-
* running, e.g. "573038". Any forward slashes in the system returned value will be removed.
239+
* running, for example "573038". Any forward slashes in the system returned value will be removed.
240240
*/
241241
public String getOsBuildVersionString() {
242242
return removeForwardSlashesIn(Build.VERSION.INCREMENTAL);

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/internal/common/NativeSessionFile.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
*/
2626
interface NativeSessionFile {
2727

28-
/** Shortname of the file sent to the reports endpoint, e.g., "logs" */
28+
/** Shortname of the file sent to the reports endpoint, for example, "logs" */
2929
@NonNull
3030
String getReportsEndpointFilename();
3131

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/internal/metadata/QueueFile.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ class QueueFile implements Closeable {
7070
* The underlying file. Uses a ring buffer to store entries. Designed so that a modification isn't
7171
* committed or visible until we write the header. The header is much smaller than a segment. So
7272
* long as the underlying file system supports atomic segment writes, changes to the queue are
73-
* atomic. Storing the file length ensures we can recover from a failed expansion (i.e. if setting
73+
* atomic. Storing the file length ensures we can recover from a failed expansion (that is, if setting
7474
* the file length succeeds but the process dies before the data can be copied).
7575
*
7676
* <p>

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/internal/metadata/UserMetadata.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ private void scheduleSerializationTaskIfNeeded() {
326326
* so, it sets the marker bit to false, so the serialized data is guaranteed to contain all
327327
* updates until the next time the marker is flipped to true.
328328
*
329-
* <p>If there's nothing to serialize (i.e., the marker bit is false), this method does nothing.
329+
* <p>If there's nothing to serialize (that is, the marker bit is false), this method does nothing.
330330
*/
331331
private void serializeIfMarked() {
332332
Map<String, String> keyData = null;

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/internal/stacktrace/MiddleOutStrategy.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
/**
1818
* Strategy for trimming a given stack trace by removing the middle portion.
1919
*
20-
* <p>The most important details in a stack are the beginning and end - i.e. the point at which it
20+
* <p>The most important details in a stack are the beginning and end - that is, the point at which it
2121
* was generated and where it originated. This strategy takes advantage of this notion and always
2222
* generates a trimmed stack of a given size by removing the middle of the stack, returning a
2323
* trimmed stack with half of the trimmed size from the beginning of the input stack, and half from

0 commit comments

Comments
 (0)