From 98103b5433f94f5879f6098c1464cd10f8784636 Mon Sep 17 00:00:00 2001 From: Araq Date: Wed, 31 Oct 2018 00:19:24 +0100 Subject: [PATCH] docgen: fixes #9432 [backport] (cherry picked from commit 48f73aaa1cc4228e5ba58f471c5f66116c9e59ad) --- compiler/evaltempl.nim | 20 +++++++ .../expected/subdir/subdir_b/utils.html | 27 +++++++++ nimdoc/testproject/expected/testproject.html | 58 +++++++++++++++++++ nimdoc/testproject/expected/theindex.html | 26 ++++++++- nimdoc/testproject/subdir/subdir_b/utils.nim | 16 +++++ nimdoc/testproject/testproject.nim | 6 ++ 6 files changed, 152 insertions(+), 1 deletion(-) diff --git a/compiler/evaltempl.nim b/compiler/evaltempl.nim index d6c630e79b..43d5a8698c 100644 --- a/compiler/evaltempl.nim +++ b/compiler/evaltempl.nim @@ -17,6 +17,7 @@ type TemplCtx = object owner, genSymOwner: PSym instLines: bool # use the instantiation lines numbers + isDeclarative: bool mapping: TIdTable # every gensym'ed symbol needs to be mapped to some # new symbol config: ConfigRef @@ -54,11 +55,30 @@ proc evalTemplateAux(templ, actual: PNode, c: var TemplCtx, result: PNode) = result.add copyNode(c, templ, actual) of nkNone..nkIdent, nkType..nkNilLit: # atom result.add copyNode(c, templ, actual) + of nkCommentStmt: + # for the documentation generator we don't keep documentation comments + # in the AST that would confuse it (bug #9432), but only if we are not in a + # "declarative" context (bug #9235). + if c.isDeclarative: + var res = copyNode(c, templ, actual) + for i in countup(0, sonsLen(templ) - 1): + evalTemplateAux(templ.sons[i], actual, c, res) + result.add res + else: + result.add newNodeI(nkEmpty, templ.info) else: + var isDeclarative = false + if templ.kind in {nkProcDef, nkFuncDef, nkMethodDef, nkIteratorDef, + nkMacroDef, nkTemplateDef, nkConverterDef, nkTypeSection, + nkVarSection, nkLetSection, nkConstSection} and + not c.isDeclarative: + c.isDeclarative = true + isDeclarative = true var res = copyNode(c, templ, actual) for i in countup(0, sonsLen(templ) - 1): evalTemplateAux(templ.sons[i], actual, c, res) result.add res + if isDeclarative: c.isDeclarative = false const errWrongNumberOfArguments = "wrong number of arguments" diff --git a/nimdoc/testproject/expected/subdir/subdir_b/utils.html b/nimdoc/testproject/expected/subdir/subdir_b/utils.html index 5ccb6c8320..2c89acce45 100644 --- a/nimdoc/testproject/expected/subdir/subdir_b/utils.html +++ b/nimdoc/testproject/expected/subdir/subdir_b/utils.html @@ -1255,6 +1255,16 @@ function main() { +
  • + Templates + +
    • @@ -1282,6 +1292,23 @@ function main() {
    constructor. +
    + + +
    +

    Templates

    +
    + +
    template aEnum(): untyped
    +
    + + +
    + +
    template bEnum(): untyped
    +
    + +
    diff --git a/nimdoc/testproject/expected/testproject.html b/nimdoc/testproject/expected/testproject.html index 96fba4a0ff..2e23a64d50 100644 --- a/nimdoc/testproject/expected/testproject.html +++ b/nimdoc/testproject/expected/testproject.html @@ -1244,6 +1244,18 @@ function main() { +
  • + Types + +
  • Vars