Commits

Herbert Breunung committed 23b24e1

expanding on internals

Comments (0)

Files changed (1)

lib/Kephra/Internals.pod

-
 =head1 Kephra::Internals
 
 If you want to touch the Kephra sources -
 In case you learn better by code - start at Kephra::API.
 
 
+
 =head2 NAMESPACES
 
-In each file is only one package with exactly the name as the files.
+In each file is only one package with exactly the same name as the file.
 
 With every directory you go deeper into the tree the modules will get more
-specific. Thats why the directory Kephra has only the most common tools
-and libraries.
+specific. Thats why the directory "lib/Kephra" has only the most common
+tools and libraries. Other dir:
 
 =over 4
 
 
 =over 4
 
-* Bar - visual units made of one widget
+* Bar - container widgets (menu bar, toolbar, tab bar, status bar, etc.)
 
-* Editor - editor window helper
+* Editor - editor widget helper
 
-* Panel - with sizer assembled visual parts
+* Panel - with sizer assembled visual units (snippet lib, io unit, etc.)
 
-* Part - functional units
+* Part - functional units (main part, side panel, etc,)
 
 =back
 
 
 
 
+=head2 MODULES
+
+=head3 Kephra
+
+contains just the init process:
+setting dirs, loading libs, finding configs, making worker fork, starting app
+
+=head4 Kephra::API
+
+interface to important internal functions all modules and plugins should use
+
+The modules in the Kephra::API::* namespace are services for a more sophisticated
+communication between the modules who do the real work.
+
+
+
+
 
 
 If you want to leave the recommended ways as proposed by the API and call
 =head3 Explained In Detail
 
 
-=head2 Modules
-
-=head4 Kephra
-
-contains just the init process:
-setting dirs, loading libs, finding configs, start worker fork
-
-=head4 Kephra::API
-
-interface to important internal functions all modules and plugins should use
-
-The modules in the Kephra::API::* namespace are services for a more sophisticated
-communication between the modules who do the real work.
 
 =head4 Kephra::API::Command