Skip to content
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.

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

Fix < and > breaking the Javadoc output #4299

Merged
merged 1 commit into from
Nov 10, 2022
Merged

Conversation

daymxn
Copy link
Member

@daymxn daymxn commented Nov 9, 2022

Per b/257287954, this PR fixes < and > symbols breaking the doc output from Dackka.

This occurs because angle brackets are broken in Dackka (see b/257276445). A workaround is to wrap them in <code> blocks. Although, looking through our existing source, it seems as though we oftentimes wrap types in code blocks anyhow- so this PR just wraps the entire type versus just wrapping the generic type (what's present in the angle brackets).

@daymxn daymxn self-assigned this Nov 9, 2022
@google-oss-bot
Copy link
Contributor

Coverage Report 1

Affected Products

  • firebase-database

    Overall coverage changed from ? (4f41bde) to 50.18% (34c1e72) by ?.

    155 individual files with coverage change

    FilenameBase (4f41bde)Merge (34c1e72)Diff
    AckUserWrite.java?88.89%?
    AndroidAppCheckTokenProvider.java?50.00%?
    AndroidAuthTokenProvider.java?42.31%?
    AndroidEventTarget.java?42.86%?
    AndroidLogger.java?45.45%?
    AndroidPlatform.java?39.02%?
    BooleanNode.java?100.00%?
    CacheNode.java?100.00%?
    CachePolicy.java?50.00%?
    CancelEvent.java?0.00%?
    Change.java?91.67%?
    ChildChangeAccumulator.java?96.67%?
    ChildEventListener.java?0.00%?
    ChildEventRegistration.java?0.00%?
    ChildKey.java?90.00%?
    ChildrenNode.java?73.40%?
    Clock.java?0.00%?
    CompoundHash.java?0.00%?
    CompoundWrite.java?87.85%?
    Connection.java?27.59%?
    ConnectionContext.java?90.00%?
    ConnectionTokenProvider.java?0.00%?
    ConnectionUtils.java?7.14%?
    Constants.java?0.00%?
    Context.java?76.99%?
    CustomClassMapper.java?88.33%?
    DatabaseConfig.java?64.58%?
    DatabaseError.java?0.00%?
    DatabaseException.java?50.00%?
    DatabaseReference.java?23.36%?
    DatabaseRegistrar.java?100.00%?
    DataEvent.java?70.00%?
    DataSnapshot.java?54.05%?
    DefaultClock.java?100.00%?
    DefaultLogger.java?66.67%?
    DefaultPersistenceManager.java?74.76%?
    DefaultRunLoop.java?57.14%?
    DeferredValueNode.java?0.00%?
    DoubleNode.java?100.00%?
    EmptyNode.java?83.33%?
    Event.java?100.00%?
    EventGenerator.java?100.00%?
    EventRaiser.java?25.00%?
    EventRegistration.java?41.18%?
    EventRegistrationZombieListener.java?0.00%?
    EventTarget.java?0.00%?
    Exclude.java?0.00%?
    FirebaseDatabase.java?29.76%?
    FirebaseDatabaseComponent.java?100.00%?
    GAuthToken.java?81.82%?
    GenericTypeIndicator.java?100.00%?
    HostInfo.java?85.71%?
    IgnoreExtraProperties.java?0.00%?
    ImmutableTree.java?84.52%?
    Index.java?53.33%?
    IndexedFilter.java?93.62%?
    IndexedNode.java?95.71%?
    InternalHelpers.java?60.00%?
    JsonMapper.java?59.32%?
    KeyIndex.java?81.82%?
    LeafNode.java?91.55%?
    LimitedFilter.java?97.67%?
    ListenComplete.java?0.00%?
    ListenHashProvider.java?0.00%?
    Logger.java?100.00%?
    LogWrapper.java?71.43%?
    LongNode.java?93.75%?
    LRUCachePolicy.java?0.00%?
    Merge.java?81.25%?
    MessageBuilderFactory.java?0.00%?
    MutableData.java?72.00%?
    NameAndPriority.java?0.00%?
    NamedNode.java?66.67%?
    Node.java?50.00%?
    NodeAndPath.java?0.00%?
    NodeFilter.java?0.00%?
    NodeSizeEstimator.java?0.00%?
    NodeUtilities.java?74.14%?
    NoopPersistenceManager.java?77.50%?
    NotNull.java?0.00%?
    Nullable.java?0.00%?
    OffsetClock.java?75.00%?
    OnDisconnect.java?0.00%?
    Operation.java?100.00%?
    OperationSource.java?94.12%?
    Overwrite.java?80.00%?
    Pair.java?30.00%?
    ParsedUrl.java?66.67%?
    Path.java?87.12%?
    PathAndId.java?0.00%?
    PathIndex.java?92.31%?
    PersistenceManager.java?0.00%?
    PersistenceStorageEngine.java?0.00%?
    PersistentConnection.java?0.00%?
    PersistentConnectionImpl.java?17.07%?
    Platform.java?0.00%?
    Predicate.java?100.00%?
    PriorityIndex.java?83.33%?
    PriorityUtilities.java?76.92%?
    PropertyName.java?0.00%?
    PruneForest.java?76.06%?
    PushIdGenerator.java?84.13%?
    Query.java?44.22%?
    QueryParams.java?89.76%?
    QuerySpec.java?88.46%?
    RangedFilter.java?100.00%?
    RangeMerge.java?0.00%?
    Repo.java?10.31%?
    RepoInfo.java?71.88%?
    RepoManager.java?32.88%?
    RequestResultCallback.java?0.00%?
    RetryHelper.java?74.19%?
    RunLoop.java?0.00%?
    ServerValue.java?0.00%?
    ServerValues.java?50.00%?
    SnapshotHolder.java?100.00%?
    SparseSnapshotTree.java?17.86%?
    SqlPersistenceStorageEngine.java?0.00%?
    StringListReader.java?0.00%?
    StringNode.java?87.50%?
    SyncPoint.java?88.89%?
    SyncTree.java?56.89%?
    Tag.java?71.43%?
    ThreadBackgroundExecutor.java?0.00%?
    ThreadInitializer.java?100.00%?
    ThreadPoolEventTarget.java?0.00%?
    ThrowOnExtraProperties.java?0.00%?
    TokenProvider.java?0.00%?
    TrackedQuery.java?46.15%?
    TrackedQueryManager.java?99.45%?
    Transaction.java?0.00%?
    Tree.java?50.00%?
    TreeNode.java?25.00%?
    UserWriteRecord.java?57.14%?
    Utilities.java?68.99%?
    Validation.java?42.67%?
    ValidationPath.java?86.96%?
    ValueEventListener.java?0.00%?
    ValueEventRegistration.java?0.00%?
    ValueIndex.java?0.00%?
    ValueProvider.java?50.00%?
    View.java?85.11%?
    ViewCache.java?100.00%?
    ViewProcessor.java?92.10%?
    WebSocket.java?37.50%?
    WebsocketConnection.java?32.77%?
    WebSocketEventHandler.java?0.00%?
    WebSocketException.java?50.00%?
    WebSocketHandshake.java?26.67%?
    WebSocketMessage.java?0.00%?
    WebSocketReceiver.java?12.82%?
    WebSocketWriter.java?19.23%?
    WriteTree.java?76.67%?
    WriteTreeRef.java?100.00%?
    ZombieEventManager.java?0.00%?

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/LM0Rst0SIK.html

@google-oss-bot
Copy link
Contributor

@github-actions
Copy link
Contributor

github-actions bot commented Nov 9, 2022

Unit Test Results

401 tests   - 573   399 ✔️  - 575   35s ⏱️ -59s
  27 suites  -   24       2 💤 +    2 
  27 files    -   24       0 ±    0 

Results for commit 58cb6d0. ± Comparison against base commit 4f41bde.

@daymxn daymxn merged commit 6e5c1b8 into master Nov 10, 2022
@daymxn daymxn deleted the daymon-fix-lt-symbols branch November 10, 2022 17:53
@firebase firebase locked and limited conversation to collaborators Dec 11, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants