tidy up namespacing

Author: vinniefalco

include/mrdox/mrdox.hpp

@@ -16,12 +16,14 @@
 #include <llvm/ADT/Twine.h>
 #include "llvm/Support/Error.h"
 
-namespace mrdox {
+namespace clang {
+namespace doc {
 
 llvm::Expected<llvm::Twine>
 renderXML(
     llvm::StringRef path);
 
-} // mrdox
+} // doc
+} // clang
 
 #endif

source/lib/Asciidoc.h

@@ -363,7 +363,7 @@ void
 listFunctions(
     ClangDocContext const& CDCtx,
     llvm::StringRef label,
-    mrdox::FunctionList const& v,
+    FunctionList const& v,
     llvm::raw_ostream& os)
 {
     if(v.empty())

source/lib/AsciidocGenerator.cpp

@@ -13,25 +13,26 @@
 #include "Reduce.h"
 #include "Representation.h"
 
+namespace clang {
+namespace doc {
+
 // we assume that there are 4 access controls
 static_assert(
-    clang::AccessSpecifier::AS_none >
-    clang::AccessSpecifier::AS_private);
+    AccessSpecifier::AS_none >
+    AccessSpecifier::AS_private);
 static_assert(
-    clang::AccessSpecifier::AS_none >
-    clang::AccessSpecifier::AS_protected);
+    AccessSpecifier::AS_none >
+    AccessSpecifier::AS_protected);
 static_assert(
-    clang::AccessSpecifier::AS_none >
-    clang::AccessSpecifier::AS_public);
-
-namespace mrdox {
+    AccessSpecifier::AS_none >
+    AccessSpecifier::AS_public);
 
 //------------------------------------------------
 
 void
 FunctionOverloads::
 insert(
-    clang::doc::FunctionInfo I)
+    FunctionInfo I)
 {
     assert(I.Name == name);
     v_.emplace_back(std::move(I));
@@ -42,13 +43,13 @@ FunctionOverloads::
 merge(
     FunctionOverloads&& other)
 {
-    clang::doc::reduceChildren(
+    reduceChildren(
         v_, std::move(other.v_));
 }
 
 FunctionOverloads::
 FunctionOverloads(
-    clang::doc::FunctionInfo I)
+    FunctionInfo I)
     : name(I.Name)
 {
     v_.emplace_back(std::move(I));
@@ -59,7 +60,7 @@ FunctionOverloads(
 void
 FunctionList::
 insert(
-    clang::doc::FunctionInfo I)
+    FunctionInfo I)
 {
     //assert(I.Access == access);
     auto it = find(I.Name);
@@ -105,4 +106,6 @@ find(
     return it;
 }
 
-} // mrdox
+} // doc
+} // clang
+

source/lib/Functions.cpp

@@ -16,7 +16,8 @@
 #include <clang/Basic/Specifiers.h>
 #include <vector>
 
-namespace mrdox {
+namespace clang {
+namespace doc {
 
 //------------------------------------------------
 
@@ -61,20 +62,20 @@ class List
 /** A list of overloads for a function.
 */
 struct FunctionOverloads
-    : List<clang::doc::FunctionInfo>
+    : List<FunctionInfo>
 {
     /// The name of the function.
     UnqualifiedName name;
 
-    void insert(clang::doc::FunctionInfo I);
+    void insert(FunctionInfo I);
     void merge(FunctionOverloads&& other);
 
     FunctionOverloads(
         FunctionOverloads&&) noexcept = default;
     FunctionOverloads& operator=(
         FunctionOverloads&&) noexcept = default;
     FunctionOverloads(
-        clang::doc::FunctionInfo I);
+        FunctionInfo I);
 };
 
 //------------------------------------------------
@@ -86,7 +87,7 @@ struct FunctionList
 {
     clang::AccessSpecifier access;
 
-    void insert(clang::doc::FunctionInfo I);
+    void insert(FunctionInfo I);
     void merge(FunctionList&& other);
 
     FunctionList(
@@ -104,6 +105,7 @@ struct FunctionList
 
 //------------------------------------------------
 
-} // mrdox
+} // doc
+} // clang
 
 #endif

source/lib/Functions.h

@@ -172,7 +172,7 @@ struct ScopeChildren
     // this general for all possible container types reduces code complexity.
     std::vector<Reference> Namespaces;
     std::vector<Reference> Records;
-    mrdox::FunctionList functions;
+    FunctionList functions;
     std::vector<EnumInfo> Enums;
     std::vector<TypedefInfo> Typedefs;
 

source/lib/Representation.h

@@ -13,26 +13,21 @@
 #define MRDOX_TYPES_HPP
 
 #include <llvm/ADT/SmallString.h>
+#include <vector>
 
 namespace clang {
 namespace doc {
-struct FunctionInfo;
-} // doc
-} // clang
-
-//------------------------------------------------
 
-namespace mrdox {
-
-namespace doc = clang::doc;
+struct FunctionInfo;
 
 /// The string used for unqualified names
 using UnqualifiedName = llvm::SmallString<16>;
 
 /// A list of zero or more functions
-using FunctionInfos = std::vector<doc::FunctionInfo>;
+using FunctionInfos = std::vector<FunctionInfo>;
 
-} // mrdox
+} // doc
+} // clang
 
 #endif
 

source/lib/Types.h

@@ -75,8 +75,8 @@ class XMLGenerator
     void write(FunctionInfo const& I);
     void write(EnumInfo const& I);
     void write(TypedefInfo const& I);
-    void write(mrdox::FunctionOverloads const& fns);
-    void write(mrdox::FunctionList const& fnList);
+    void write(FunctionOverloads const& fns);
+    void write(FunctionList const& fnList);
     void write(std::vector<EnumInfo> const& v);
     void write(std::vector<TypedefInfo> const& v);
 
@@ -328,7 +328,7 @@ write(
 void
 XMLGenerator::
 write(
-    mrdox::FunctionOverloads const& fns)
+    FunctionOverloads const& fns)
 {
     for(auto const& fn : fns)
         write(fn);
@@ -337,7 +337,7 @@ write(
 void
 XMLGenerator::
 write(
-    mrdox::FunctionList const& fnList)
+    FunctionList const& fnList)
 {
     for(auto const& fns : fnList)
         write(fns);
@@ -401,43 +401,31 @@ char const*
 XMLGenerator::
 Format = "xml";
 
-} // doc
-} // clang
-
 //------------------------------------------------
 
-namespace mrdox {
-
 llvm::Expected<llvm::Twine>
 renderXML(
     llvm::StringRef path)
 {
     return llvm::Twine();
 }
 
-} // mrdox
-
 //------------------------------------------------
 
-using namespace llvm;
-
-namespace clang {
-namespace doc {
-
 static
-clang::doc::GeneratorRegistry::Add<
-    clang::doc::XMLGenerator>
+GeneratorRegistry::Add<XMLGenerator>
 xmlGenerator(
-    clang::doc::XMLGenerator::Format,
+    XMLGenerator::Format,
     "Generator for XML output.");
 
 // This anchor is used to force the linker
 // to link in the generated object file and
 // thus register the generator.
 volatile int XMLGeneratorAnchorSource = 0;
 
-}
-}
+using namespace llvm;
+} // doc
+} // clang
 
 void
 force_xml_generator_linkage()

source/lib/XMLGenerator.cpp

@@ -22,9 +22,8 @@
 // and a .xml file containing the expected output
 // of the XML generator, which must match exactly.
 
-// Our namespace insulates us from any unexpected
-// declarations thrown in the global namespace.
-namespace mrdox {
+namespace clang {
+namespace doc {
 
 int
 do_main(int argc, const char** argv)
@@ -94,17 +93,18 @@ do_main(int argc, const char** argv)
         }
         expectedXml = xmlResult->get()->getBuffer();
 
-        auto const result = mrdox::renderXML(cppPath);
+        auto const result = renderXML(cppPath);
 
     }
 
     return EXIT_SUCCESS;
 }
 
-} // mrdox
+} // doc
+} // clang
 
 int
 main(int argc, const char** argv)
 {
-    return mrdox::do_main(argc, argv);
+    return clang::doc::do_main(argc, argv);
 }