src/nitdoc.nit

   1 # This file is part of NIT ( http://www.nitlanguage.org ).
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 # Documentation generator for the nit language.
  16 #
  17 # Generate API documentation in HTML format from nit source code.
  18 module nitdoc
  19
  20 import modelbuilder
  21 import doc
  22
  23 redef class ToolContext
  24         # Nitdoc generation phase.
  25         var docphase: Phase = new Nitdoc(self, null)
  26 end
  27
  28 # Nitdoc phase explores the model and generate pages for each mentities found
  29 private class Nitdoc
  30         super Phase
  31         redef fun process_mainmodule(mainmodule, mmodules)
  32         do
  33                 var doc = new DocModel(mainmodule.model, mainmodule)
  34
  35                 var phases = [
  36                         new ExtractionPhase(toolcontext, doc),
  37                         new IndexingPhase(toolcontext, doc),
  38                         new MakePagePhase(toolcontext, doc),
  39                         new POSetPhase(toolcontext, doc),
  40                         new ConcernsPhase(toolcontext, doc),
  41                         new StructurePhase(toolcontext, doc),
  42                         new InheritanceListsPhase(toolcontext, doc),
  43                         new IntroRedefListPhase(toolcontext, doc),
  44                         new LinListPhase(toolcontext, doc),
  45                         new GraphPhase(toolcontext, doc),
  46                         new RenderHTMLPhase(toolcontext, doc): DocPhase]
  47
  48                 for phase in phases do
  49                         toolcontext.info("# {phase.class_name}", 1)
  50                         phase.apply
  51                 end
  52         end
  53 end
  54
  55 # build toolcontext
  56 var toolcontext = new ToolContext
  57 var tpl = new Template
  58 tpl.add "Usage: nitdoc [OPTION]... <file.nit>...\n"
  59 tpl.add "Generates HTML pages of API documentation from Nit source files."
  60 toolcontext.tooldescription = tpl.write_to_string
  61
  62 # process options
  63 toolcontext.process_options(args)
  64 var arguments = toolcontext.option_context.rest
  65
  66 # build model
  67 var model = new Model
  68 var mbuilder = new ModelBuilder(model, toolcontext)
  69 var mmodules = mbuilder.parse_full(arguments)
  70
  71 # process
  72 if mmodules.is_empty then return
  73 mbuilder.run_phases
  74 toolcontext.run_global_phases(mmodules)