Skip to content

Commit 1ab8a7e

Browse files
author
Alex Ames
authored
Workaround for issue with Doxygen doc generation. (#497)
* Workaround for issue with Doxygen doc generation. Due to a bug (https://bugzilla.gnome.org/show_bug.cgi?id=735376) with the version of doxygen we use to generate reference documentation, forward declaration of template types results in them being misclassified as singletons instead of classes. Omit the forward declarations from Doxygen doc generation until we can update the version of Doxygen that we use.
1 parent 3177560 commit 1ab8a7e

File tree

5 files changed

+11
-4
lines changed

5 files changed

+11
-4
lines changed

auth/src/include/firebase/auth/credential.h

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,18 @@
2121

2222
#include <string>
2323

24-
#include "firebase/internal/common.h"
2524
#include "firebase/auth/types.h"
25+
#include "firebase/internal/common.h"
2626

2727
namespace firebase {
2828

2929
// Predeclarations.
3030
class App;
3131

32+
/// @cond FIREBASE_APP_INTERNAL
3233
template <typename T>
3334
class Future;
35+
/// @endcond
3436

3537
namespace auth {
3638

@@ -205,7 +207,6 @@ class GoogleAuthProvider {
205207
static const char* const kProviderId;
206208
};
207209

208-
209210
/// @brief Use an access token provided by Microsoft to authenticate.
210211
class MicrosoftAuthProvider {
211212
public:
@@ -612,15 +613,13 @@ class TwitterAuthProvider {
612613
static const char* const kProviderId;
613614
};
614615

615-
616616
/// @brief Use an access token provided by Yahoo to authenticate.
617617
class YahooAuthProvider {
618618
public:
619619
/// The string used to identify this provider.
620620
static const char* const kProviderId;
621621
};
622622

623-
624623
} // namespace auth
625624
} // namespace firebase
626625

firestore/src/include/firebase/firestore/collection_reference.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@
2424

2525
namespace firebase {
2626

27+
/// @cond FIREBASE_APP_INTERNAL
2728
template <typename T>
2829
class Future;
30+
/// @endcond
2931

3032
namespace firestore {
3133

firestore/src/include/firebase/firestore/document_reference.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,10 @@
3333

3434
namespace firebase {
3535

36+
/// @cond FIREBASE_APP_INTERNAL
3637
template <typename T>
3738
class Future;
39+
/// @endcond
3840

3941
namespace firestore {
4042

firestore/src/include/firebase/firestore/query.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,10 @@
3232
#include "firebase/firestore/source.h"
3333

3434
namespace firebase {
35+
/// @cond FIREBASE_APP_INTERNAL
3536
template <typename T>
3637
class Future;
38+
/// @endcond
3739

3840
namespace firestore {
3941

firestore/src/include/firebase/firestore/write_batch.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@
2222

2323
namespace firebase {
2424

25+
/// @cond FIREBASE_APP_INTERNAL
2526
template <typename T>
2627
class Future;
28+
/// @endcond
2729

2830
namespace firestore {
2931

0 commit comments

Comments
 (0)