[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    [atcore] /:  Update base documents
From:       Chris Rizzitello <null () kde ! org>
Date:       2018-06-01 1:09:13
Message-ID: E1fOYZ7-0003iD-8e () code ! kde ! org
[Download RAW message or body]

Git commit cc8ad0695736d52c998e50a2be7fa6ba59f08ff6 by Chris Rizzitello.
Committed on 01/06/2018 at 01:01.
Pushed by rizzitello into branch 'master'.

Update base documents

Signed-off-by: Chris Rizzitello <rizzitello@kde.org>

M  +1    -1    doc/contrib.md
M  +4    -1    doc/mainpage.md
M  +3    -4    src/core/atcore.h

https://commits.kde.org/atcore/cc8ad0695736d52c998e50a2be7fa6ba59f08ff6

diff --git a/doc/contrib.md b/doc/contrib.md
index 4452ebd..1cd0c78 100644
--- a/doc/contrib.md
+++ b/doc/contrib.md
@@ -15,7 +15,7 @@ The following guidelines apply to all submited code.
  - Use constant referances when possible
  - Includes should be alphabetical.
  - Run the style script before you commit.
- - Headers should use #pragma once not #ifndef Def.
+ - Headers should use `#pragma once`.
  - Auto should not be used if the type is not explict.
  - Doxygen comments should be created/updated with code.
  - Objects should have logical varible and function names
diff --git a/doc/mainpage.md b/doc/mainpage.md
index 276aa66..d951b96 100644
--- a/doc/mainpage.md
+++ b/doc/mainpage.md
@@ -28,9 +28,12 @@ Currenty the following firmwares are supported.
  See: [Building and Deploying]
 =

 ## Importing %AtCore in your CMakeList
-CMake should find %AtCore using the following in your CMakeLists
+CMake should find %AtCore and link it to MYAPP using the following in your=
 CMakeLists
 ```CMake
 include (AtCore REQUIRED COMPONATES AtCore )
+include (AtCore REQUIRED COMPONATES AtCoreWidgets )
+...
+target_link_libraries(MYAPP AtCore::AtCore AtCore::AtCoreWidgets ... )
 ```
 =

 ## Getting Involved
diff --git a/src/core/atcore.h b/src/core/atcore.h
index fafa0c2..ade3932 100644
--- a/src/core/atcore.h
+++ b/src/core/atcore.h
@@ -50,13 +50,12 @@ struct AtCorePrivate;
  * - AtCore::close() when you are all done.
 =

  * #### How AtCore Finds Plugins.
- *  - Windows and Mac Os will always look in appdir/plugins for plugins.
- *
- * Others Search:
+ * Searched Paths:
  *  1. Build Dir/plugins (buildtime)
  *  2. ECM set KDE PLUGIN DIR  (buildtime)
  *  3. Qt Plugin path/AtCore (runtime)
- *  4. plugins (runtime)
+ *  4. Fullpath of KDE_PLUGIN_DIR (buildtime)
+ *  5. Program using atcore's path/plugins (runtime)
  */
 class ATCORE_EXPORT AtCore : public QObject
 {

[prev in list] [next in list] [prev in thread] [next in thread]