You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by rm...@apache.org on 2021/11/28 17:14:33 UTC

[logging-log4cxx] 02/02: Updated documentation slightly

This is an automated email from the ASF dual-hosted git repository.

rmiddleton pushed a commit to branch LOGCXX-510
in repository https://gitbox.apache.org/repos/asf/logging-log4cxx.git

commit c7a145fed802a34c654c11377856bdb5ff8faabb
Author: Robert Middleton <ro...@rm5248.com>
AuthorDate: Sun Nov 28 12:11:15 2021 -0500

    Updated documentation slightly
---
 src/site/markdown/library-design.md | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

diff --git a/src/site/markdown/library-design.md b/src/site/markdown/library-design.md
index ecd90a0..7c3e2dd 100644
--- a/src/site/markdown/library-design.md
+++ b/src/site/markdown/library-design.md
@@ -67,16 +67,16 @@ This can be done to any depth that is required.
 
 ## Example
 
-Parent-private.h:
+parent\_priv.h:
 ```
-#include "Parent.h"
+#include "parent.h"
 
 struct Parent::ParentPrivate{
   int parentVariable;
 };
 ```
 
-Parent.h:
+parent.h:
 ```
 class Parent {
 pubic:
@@ -85,19 +85,21 @@ pubic:
   virtual ~Parent();
 
 protected:
-  std::unique_ptr<AppenderSkeletonPrivate> m_priv;
+  std::unique_ptr<ParentPrivate> m_priv;
 };
 ```
 
-Parent.cpp:
+parent.cpp:
 ```
+#include "parent_priv.h"
+
 Parent::Parent( std::unique_ptr<ParentPrivate> priv ) :
   m_priv( std::move(priv) ){}
 ```
 
-Child.h:
+child.h:
 ```
-#include "Parent.h"
+#include "parent.h"
 
 class Child : public Parent {
 public:
@@ -111,10 +113,10 @@ private:
 };
 ```
 
-Child.cpp:
+child.cpp:
 ```
-#include "Parent-private.h"
-#include "Child.h"
+#include "parent_priv.h"
+#include "child.h"
 
 struct Child::ChildPriv : public Parent::ParentPriv {
   int childVariable;