1. Herbert Breunung
  2. Kephra

Commits

Herbert Breunung  committed 8885865

documenting the API module

  • Participants
  • Parent commits 9ee8bc5
  • Branches default

Comments (0)

Files changed (5)

File lib/Kephra/API.pm

View file
  • Ignore whitespace
 use Kephra::Log;
 use Kephra::PluginRegistrar;
 use Kephra::SandrumInterpreter;
+use Kephra::Worker;
 
 package Kephra::API;
 my $VERSION = 0.1;

File lib/Kephra/Internals.pod

View file
  • Ignore whitespace
 =head1 API
 
+The module Kephra::API is the best starting point to understand the inner workings.
+It's one design goal and purpose of this file, because it gives an overview of
+all important functions and values and shows where they originate. From here
+you can step to the other major interfaces that can be seen in the first lines.
+
+But more vitally it decouples cross module calls and allows to change things
+under the hood. As long as the first version number (see L<Versioning>)
+does not change, nothing will be removed from the API.
+
+=head1 CommandList
+
+=head1 KeyMap
+
+=head1 EventTable
 
 =head1 Glossary
 

File lib/Kephra/Versioning.pod

View file
  • Ignore whitespace
 
   Revision . Stable . Testing . Development
 
+Trailing zeros can be omited - 0.5 is the same as 0.5.0.0
+
 =head3 Development
 
 Development number is changed after every important commit.
 
 Stable releases should have a polished interface and no bugs.
 If one appears in 0.3 it will be fixed ASAP with 0.3.0.1 a.s.o.
+
 During a time window before releasing a stable version,
 all new features will go into a new branch, which will become 0.3.1.
 The next testing should be released soon after the stable is out.
 
 Has the word vision in it. When I got my initial vision we are at 1.0.
 If I have a new one after that or we change a fundamental technology
-there is gonna be a 2.0. 
-Or in case we just want to break backward compatibelity of the Kephra::API.
+there is gonna be a 2.0.
+
+Or in case we just want to break backward compatibility of the Kephra::API,
+it is a signal to all Plugin authors, they have to adapt.
 
 =head2 What Changed?
 

File lib/Kephra/Worker.pm

View file
  • Ignore whitespace
+use strict;
+use warnings;
+
+package Kephra::Worker;
+
+# create a new worker
+sub spawn {}
+
+sub create_job {}
+sub get_result {}
+
+
+1;

File lib/Kephra/Works.pm

  • Ignore whitespace
-use strict;
-use warnings;
-
-package Kephra::Works;
-
-# create a new worker
-sub spawn {}
-
-sub create_job {}
-sub get_result {}
-
-
-1;