Skip to content

Commit 1cf68d5

Browse files
Chore: Remove extraneous same-line comments on #includes
This commit removes explanatory comments I added on the same line as #include directives in various files related to the ListResult feature. These comments were deemed unnecessary as the purpose of the includes is generally clear from context or the header filename itself. This cleanup enhances code readability by reducing clutter in the include blocks. No functional code changes are included. Files affected: - storage/src/common/list_result.cc - storage/src/desktop/list_result_desktop.h - storage/src/android/list_result_android.h - storage/src/ios/list_result_ios.h - storage/src/common/storage_reference.cc (And potentially platform .cc/.mm files for list_result if any same-line include comments were found and removed there, though I found none for those.)
1 parent 1d4e3d3 commit 1cf68d5

File tree

5 files changed

+16
-17
lines changed

5 files changed

+16
-17
lines changed

storage/src/android/list_result_android.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
#include <vector>
77

88
#include "firebase/storage/storage_reference.h"
9-
#include "storage/src/android/storage_reference_android.h" // Defines firebase::storage::internal::StorageReferenceInternal for android
10-
#include "storage/src/android/storage_internal_android.h" // Defines firebase::storage::internal::StorageInternal for android
9+
#include "storage/src/android/storage_reference_android.h"
10+
#include "storage/src/android/storage_internal_android.h"
1111

1212
namespace firebase {
1313
namespace storage {

storage/src/common/list_result.cc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
// File: storage/src/common/list_result.cc
22

3-
#include "firebase/storage/list_result.h" // For ListResult public class
4-
#include "app/src/include/firebase/internal/platform.h" // For FIREBASE_PLATFORM defines
5-
#include "app/src/cleanup_notifier.h" // For CleanupNotifier
6-
#include "app/src/log.h" // For LogDebug, LogWarning
7-
#include "firebase/storage/storage_reference.h" // For StorageReference (used by ListResult members)
3+
#include "firebase/storage/list_result.h"
4+
#include "app/src/include/firebase/internal/platform.h"
5+
#include "app/src/cleanup_notifier.h"
6+
#include "app/src/log.h"
7+
#include "firebase/storage/storage_reference.h"
88

99
// Platform-specific headers that define internal::ListResultInternal (the PIMPL class)
1010
// and internal::StorageInternal (for CleanupNotifier context).

storage/src/common/storage_reference.cc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,10 @@
1414

1515
#include "storage/src/include/firebase/storage/storage_reference.h"
1616

17-
#include "firebase/storage/list_result.h" // Public header for ListResult
18-
// storage/src/common/storage_reference_internal.h is generally included by platform-specific storage_reference_*.h
19-
#include "app/src/assert.h" // For FIREBASE_ASSERT_RETURN
20-
#include "app/src/future_manager.h" // For ReferenceCountedFutureImpl
21-
#include "app/src/include/firebase/internal/platform.h" // For FIREBASE_PLATFORM defines
17+
#include "firebase/storage/list_result.h"
18+
#include "app/src/assert.h"
19+
#include "app/src/future_manager.h"
20+
#include "app/src/include/firebase/internal/platform.h"
2221

2322
// Platform-specific ListResultInternal definition.
2423
#if FIREBASE_PLATFORM_ANDROID

storage/src/desktop/list_result_desktop.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
#include <string>
66
#include <vector>
77

8-
#include "firebase/storage/storage_reference.h" // For firebase::storage::StorageReference
9-
#include "storage/src/desktop/storage_reference_desktop.h" // Defines firebase::storage::internal::StorageReferenceInternal for desktop
10-
#include "storage/src/desktop/storage_internal_desktop.h" // Defines firebase::storage::internal::StorageInternal for desktop
8+
#include "firebase/storage/storage_reference.h"
9+
#include "storage/src/desktop/storage_reference_desktop.h"
10+
#include "storage/src/desktop/storage_internal_desktop.h"
1111

1212
namespace firebase {
1313
namespace storage {

storage/src/ios/list_result_ios.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
#include <vector>
77

88
#include "firebase/storage/storage_reference.h"
9-
#include "storage/src/ios/storage_reference_ios.h" // Defines firebase::storage::internal::StorageReferenceInternal for ios
10-
#include "storage/src/ios/storage_internal_ios.h" // Defines firebase::storage::internal::StorageInternal for ios
9+
#include "storage/src/ios/storage_reference_ios.h"
10+
#include "storage/src/ios/storage_internal_ios.h"
1111

1212
namespace firebase {
1313
namespace storage {

0 commit comments

Comments
 (0)