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 GraphPhase(toolcontext, doc),
  45                         new RenderHTMLPhase(toolcontext, doc): DocPhase]
  46
  47                 for phase in phases do
  48                         toolcontext.info("# {phase.class_name}", 1)
  49                         phase.apply
  50                 end
  51         end
  52 end
  53
  54 # build toolcontext
  55 var toolcontext = new ToolContext
  56 var tpl = new Template
  57 tpl.add "Usage: nitdoc [OPTION]... <file.nit>...\n"
  58 tpl.add "Generates HTML pages of API documentation from Nit source files."
  59 toolcontext.tooldescription = tpl.write_to_string
  60
  61 # process options
  62 toolcontext.process_options(args)
  63 var arguments = toolcontext.option_context.rest
  64
  65 # build model
  66 var model = new Model
  67 var mbuilder = new ModelBuilder(model, toolcontext)
  68 var mmodules = mbuilder.parse_full(arguments)
  69
  70 # process
  71 if mmodules.is_empty then return
  72 mbuilder.run_phases
  73 toolcontext.run_global_phases(mmodules)