diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/README_8md.html b/README_8md.html new file mode 100644 index 0000000..561f54e --- /dev/null +++ b/README_8md.html @@ -0,0 +1,83 @@ + + +
+ + + + +
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
▼Ndire | |
▼Nbase | |
CBaseDirsBundle | |
▼Nproject | |
CIReallyWantMyOwnPlatformProjectName | |
CPlatformProjectName | |
CProjectDirsBundle | |
▼Nuser | |
CUserDirsBundle | |
▼NMyLibrary | |
CExample | Example class to demonstrate the features of the custom CSS |
CSecondExample | |
CSubclassExample | Some subclass |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
#include <dire/defines.hpp>
Go to the source code of this file.
++Classes | |
struct | dire::base::BaseDirsBundle |
+Namespaces | |
namespace | dire |
namespace | dire::base |
namespace | dire::base::detail |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
This is the complete list of members for MyLibrary::Example, including all inherited members.
+staticfunc() | MyLibrary::Example | static |
test(const std::string &test) | MyLibrary::Example | |
virtualfunc()=0 | MyLibrary::Example | pure virtual |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
Example class to demonstrate the features of the custom CSS. + More...
+ +#include <example.hpp>
+Public Member Functions | |
std::string | test (const std::string &test) |
brief summary | |
virtual int | virtualfunc ()=0 |
+Static Public Member Functions | |
static bool | staticfunc () |
Example class to demonstrate the features of the custom CSS.
+ +
+
|
+ +static | +
std::string MyLibrary::Example::test | +( | +const std::string & | +test | ) | ++ |
brief summary
+doxygen test documentation
+test | this is the only parameter of this test function. It does nothing! |
These elements have been tested with the custom CSS.
+Item | Title | Description | More |
---|---|---|---|
1 | Foo | A placeholder | Some lorem ipsum to make this table wider. |
2 | Bar | Also a placeholder | More lorem ipsum. |
3 | Baz | The third placeholder | More lorem ipsum. |
<center>
html tag:Item | Title | Description | More |
---|---|---|---|
1 | Foo | A placeholder | Some lorem ipsum to make this table wider. |
2 | Bar | Also a placeholder | More lorem ipsum. |
3 | Baz | The third placeholder | More lorem ipsum. |
<div class="full_width_table">
fills the full page width. Item | Title | Description | More |
---|---|---|---|
1 | Foo | A placeholder | Some lorem ipsum to make this table wider. |
2 | Bar | Also a placeholder | More lorem ipsum. |
3 | Baz | The third placeholder | More lorem ipsum. |
Column 1 | Column 2 | Column 3 |
---|---|---|
cell row=1+2,col=1 | cell row=1,col=2 | cell row=1,col=3 |
cell row=2+3,col=2 | cell row=2,col=3 | |
cell row=3,col=1 | cell row=3,col=3 |
first_column | second_column | third_column | fourth_column | fifth_column | sixth_column | seventh_column | eighth_column | ninth_column |
---|---|---|---|---|---|---|---|---|
1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 |
Column 1 | Column 2 |
---|---|
← the image should not be inverted in dark-mode |
Graphviz diagrams support dark mode and can be scrolled once they get too wide:
+++Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vitae proin sagittis nisl rhoncus mattis rhoncus urna neque viverra. Velit sed ullamcorper morbi tincidunt ornare.
+Lorem ipsum dolor sit amet consectetur adipiscing elit duis.
+
- jothepro
+// code within indented code block +auto test = std::shared_ptr<Example(5); +
Inline code
elements in a text. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. This also works within multiline text and does not break the layout
.
code
:
+
|
+ +pure virtual | +
Implemented in MyLibrary::SubclassExample< TemplatedClass >.
+ +
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
This is the complete list of members for MyLibrary::SecondExample, including all inherited members.
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
#include <example.hpp>
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
This is the complete list of members for MyLibrary::SubclassExample< TemplatedClass >, including all inherited members.
+function_template_test(std::shared_ptr< T > ¶m) | MyLibrary::SubclassExample< TemplatedClass > | |
long_function_with_many_parameters(std::shared_ptr< T > ¶m1, std::shared_ptr< std::string > ¶m2, bool parameter3, Alice paramater4 Bob parameter 5) | MyLibrary::SubclassExample< TemplatedClass > | inline |
staticfunc() | MyLibrary::Example | static |
test(const std::string &test) | MyLibrary::Example | |
virtualfunc() override | MyLibrary::SubclassExample< TemplatedClass > | virtual |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
some subclass + More...
+ +#include <subclass-example.hpp>
+Public Member Functions | |
int | virtualfunc () override |
template<typename T > | |
std::shared_ptr< std::string > | function_template_test (std::shared_ptr< T > ¶m) |
Template function function. | |
template<typename T , typename Foo , typename Bar , typename Alice , typename Bob , typename Charlie , typename Hello , typename World > | |
std::pair< std::string, std::string > | long_function_with_many_parameters (std::shared_ptr< T > ¶m1, std::shared_ptr< std::string > ¶m2, bool parameter3, Alice paramater4 Bob parameter 5) |
Extra long function with lots of parameters and many template types. | |
Public Member Functions inherited from MyLibrary::Example | |
std::string | test (const std::string &test) |
brief summary | |
+Additional Inherited Members | |
Static Public Member Functions inherited from MyLibrary::Example | |
static bool | staticfunc () |
some subclass
+std::shared_ptr< std::string > MyLibrary::SubclassExample< TemplatedClass >::function_template_test | +( | +std::shared_ptr< T > & | +param | ) | ++ |
Template function function.
+ +
+
|
+ +inline | +
Extra long function with lots of parameters and many template types.
+Also has a long return type.
+param1 | first parameter |
param2 | second parameter |
parameter3 | third parameter |
+
|
+ +overridevirtual | +
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
This is the complete list of members for dire::project::IReallyWantMyOwnPlatformProjectName, including all inherited members.
+IReallyWantMyOwnPlatformProjectName(Path name) | dire::project::IReallyWantMyOwnPlatformProjectName | inlineexplicit |
operator Path() && | dire::project::IReallyWantMyOwnPlatformProjectName | inlineexplicit |
operator Path const &() const | dire::project::IReallyWantMyOwnPlatformProjectName | inlineexplicit |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
#include <project.hpp>
+Public Member Functions | |
IReallyWantMyOwnPlatformProjectName (Path name) | |
operator Path const & () const | |
operator Path () && | |
+
|
+ +inlineexplicit | +
+
|
+ +inlineexplicit | +
+
|
+ +inlineexplicit | +
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
This is the complete list of members for dire::project::PlatformProjectName, including all inherited members.
+name | dire::project::PlatformProjectName | friend |
operator Path() && | dire::project::PlatformProjectName | inlineexplicit |
operator Path const &() const | dire::project::PlatformProjectName | inlineexplicit |
PlatformProjectName(IReallyWantMyOwnPlatformProjectName name) | dire::project::PlatformProjectName | inline |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
#include <project.hpp>
+Public Member Functions | |
PlatformProjectName (IReallyWantMyOwnPlatformProjectName name) | |
operator Path const & () const | |
operator Path () && | |
+Friends | |
auto | name (std::string domain, std::string org, std::string app_name) -> PlatformProjectName |
+
|
+ +inline | +
+
|
+ +inlineexplicit | +
+
|
+ +inlineexplicit | +
+
|
+ +friend | +
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
#include <filesystem>
#include <optional>
Go to the source code of this file.
++Namespaces | |
namespace | dire |
+Typedefs | |
using | dire::Path = std::filesystem::path |
template<typename T > | |
using | dire::Optional = std::optional< T > |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+Directories | |
doxygen-awesome-css | |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+Directories | |
doxygen | |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+Directories | |
lib | |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+Files | |
all.hpp | |
base.hpp | |
defines.hpp | |
project.hpp | |
user.hpp | |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+Directories | |
MyLibrary | |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+Directories | |
dire | |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+Directories | |
include | |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+Files | |
example.hpp | |
subclass-example.hpp | |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
#include <string>
Go to the source code of this file.
++Classes | |
class | MyLibrary::Example |
Example class to demonstrate the features of the custom CSS. More... | |
class | MyLibrary::SecondExample |
+Namespaces | |
namespace | MyLibrary |
+Enumerations | |
enum | MyLibrary::Color { MyLibrary::red +, MyLibrary::green +, MyLibrary::blue + } |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
▼ docs | |
▼ doxygen | |
▼ doxygen-awesome-css | |
docs | |
▼ include | |
▼ MyLibrary | |
example.hpp | |
subclass-example.hpp | |
▼ src | |
▼ lib | |
▼ include | |
▼ dire | |
all.hpp | |
base.hpp | |
defines.hpp | |
project.hpp | |
user.hpp |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
Cdire::base::BaseDirsBundle | |
▼CMyLibrary::Example | Example class to demonstrate the features of the custom CSS |
CMyLibrary::SubclassExample< TemplatedClass > | Some subclass |
Cdire::project::IReallyWantMyOwnPlatformProjectName | |
Cdire::project::PlatformProjectName | |
Cdire::project::ProjectDirsBundle | |
CMyLibrary::SecondExample | |
Cdire::user::UserDirsBundle |
+ Dire
+
+ Complete cross-platform solution for data and user directories discovery.
+ |
+
++[!WARNING] Still WIP. Wait a few days before this gets properly released with proper docs and build options.
+
++[!NOTE] This started as a simple port of
+dirs-dev/directories-rs
, but deviated in the process, the exact details can be found here.
A complete cross-platform solution for user and data directories discovery with OOTB project support.
+TODO:
Plans:
[ ] Package returned dirs in special objects with the following methods *****:
writable() -> bool
- cross platform checking if the dir is writable into (we mean every notion of writable - delete, update, create new file, etc.)readable() -> bool
- cross platform checking if the dir is readble (same here)writable_and_readable() -> bool
- return writable() and readable();
is_empty() -> bool
- checks if the directory is emptypurge() -> bool
(only for project) - removes the directory with the files insideclear() -> bool
(only for project) - clears files insideAll of these would possibly return something else than bool
for better error handling, especialy purge()
and clear()
.
appendExtra(Data|Config)Directories
from sago007/PlatformFolders
*****:***** Only if there will be need to, e.g. someone asks for that or it will be a feasible fix for an issue
+