nitc: document the phase detecting the annots `platform` and `pkgconfig`

Signed-off-by: Alexis Laferrière <alexis.laf@xymus.net>

diff --git a/src/ffi/pkgconfig.nit b/src/ffi/pkgconfig.nit
index 453ddfc..84c4274 100644 (file)
--- a/src/ffi/pkgconfig.nit
+++ b/src/ffi/pkgconfig.nit
@@ -23,11 +23,12 @@ private import annotation
 private import literal
 
 redef class ToolContext
+       # Detects the `pkgconfig` annotation on the module declaration only
        var pkgconfig_phase: Phase = new PkgconfigPhase(self, [literal_phase])
 end
 
-# Detects the `pkgconfig` annotation on the module declaration only.
-class PkgconfigPhase
+# Detects the `pkgconfig` annotation on the module declaration only
+private class PkgconfigPhase
        super Phase
 
        redef fun process_annotated_node(nmoduledecl, nat)
@@ -43,7 +44,7 @@ class PkgconfigPhase
                        return
                end
 
-               # retreive module
+               # retrieve module
                var nmodule = nmoduledecl.parent.as(AModule)
                var mmodule = nmodule.mmodule.as(not null)
 

diff --git a/src/platform/platform.nit b/src/platform/platform.nit
index 8fafcd1..3aec2f5 100644 (file)
--- a/src/platform/platform.nit
+++ b/src/platform/platform.nit
@@ -23,8 +23,10 @@ private import parser_util
 private import annotation
 
 redef class ToolContext
+       # Detects the `platform` annotation to set a mobile target platform
        var platform_phase: Phase = new PlatformPhase(self, [modelize_property_phase])
 
+       # Get platform compilation settings from its `name`
        protected fun platform_from_name(name: String): nullable Platform
        do
                return null