From d9a5085967901cb7f9188449c55c0b142d471ff8 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jean-Christophe=20Beaupr=C3=A9?= Date: Sat, 20 Dec 2014 12:31:31 -0500 Subject: [PATCH] neo_doxygen: Document implicit classes. MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jean-Christophe Beaupré --- .../neo_doxygen/src/model/namespace_members.nit | 5 ++ .../src/tests/neo_doxygen_namespace_members.nit | 1 + tests/sav/neo_doxygen_namespace_members.res | 68 ++++++++++---------- 3 files changed, 40 insertions(+), 34 deletions(-) diff --git a/contrib/neo_doxygen/src/model/namespace_members.nit b/contrib/neo_doxygen/src/model/namespace_members.nit index ce73ee3..4c85d5a 100644 --- a/contrib/neo_doxygen/src/model/namespace_members.nit +++ b/contrib/neo_doxygen/src/model/namespace_members.nit @@ -65,4 +65,9 @@ class SelfClass super name = "(self)" end + + redef fun put_in_graph do + if doc.is_empty then doc = namespace.doc + super + end end diff --git a/contrib/neo_doxygen/src/tests/neo_doxygen_namespace_members.nit b/contrib/neo_doxygen/src/tests/neo_doxygen_namespace_members.nit index 346723d..4e67bfe 100644 --- a/contrib/neo_doxygen/src/tests/neo_doxygen_namespace_members.nit +++ b/contrib/neo_doxygen/src/tests/neo_doxygen_namespace_members.nit @@ -33,6 +33,7 @@ member.put_in_graph ns.model_id = "namespacefoo" ns.name = "foo" ns.declare_member(member) +ns.doc.add "A documented namespace." ns.put_in_graph root_ns.declare_namespace("namespacefoo", "") diff --git a/tests/sav/neo_doxygen_namespace_members.res b/tests/sav/neo_doxygen_namespace_members.res index c785591..753a400 100644 --- a/tests/sav/neo_doxygen_namespace_members.res +++ b/tests/sav/neo_doxygen_namespace_members.res @@ -51,8 +51,8 @@ Edge 3:foo 7:MEntity 6:MGroup -=properties=JsonObject(1): -{"name":"foo"} +=properties=JsonObject(2): +{"name":"foo","mdoc":["A documented namespace."]} ---- =to=Entity#0: =labels=Array(3): @@ -80,8 +80,8 @@ Edge 3:foo 7:MEntity 6:MGroup -=properties=JsonObject(1): -{"name":"foo"} +=properties=JsonObject(2): +{"name":"foo","mdoc":["A documented namespace."]} Edge =type=8:DECLARES @@ -93,16 +93,16 @@ Edge 3:foo 7:MEntity 6:MGroup -=properties=JsonObject(1): -{"name":"foo"} +=properties=JsonObject(2): +{"name":"foo","mdoc":["A documented namespace."]} ---- =to=Entity#0: =labels=Array(3): 3:foo 7:MEntity 7:MModule -=properties=JsonObject(2): -{"location":"\/dev\/null:1,1--1,1","name":"foo"} +=properties=JsonObject(3): +{"location":"\/dev\/null:1,1--1,1","name":"foo","mdoc":["A documented namespace."]} Edge =type=10:INTRODUCES @@ -114,16 +114,16 @@ Edge 3:foo 7:MEntity 7:MModule -=properties=JsonObject(2): -{"location":"\/dev\/null:1,1--1,1","name":"foo"} +=properties=JsonObject(3): +{"location":"\/dev\/null:1,1--1,1","name":"foo","mdoc":["A documented namespace."]} ---- =to=Entity#0: =labels=Array(3): 3:foo 7:MEntity 6:MClass -=properties=JsonObject(4): -{"kind":"class","visibility":"public","name":"(self)","location":"\/dev\/null:1,1--1,1"} +=properties=JsonObject(5): +{"kind":"class","visibility":"public","name":"(self)","mdoc":["A documented namespace."],"location":"\/dev\/null:1,1--1,1"} Edge =type=7:DEFINES @@ -135,16 +135,16 @@ Edge 3:foo 7:MEntity 7:MModule -=properties=JsonObject(2): -{"location":"\/dev\/null:1,1--1,1","name":"foo"} +=properties=JsonObject(3): +{"location":"\/dev\/null:1,1--1,1","name":"foo","mdoc":["A documented namespace."]} ---- =to=Entity#0: =labels=Array(3): 3:foo 7:MEntity 9:MClassDef -=properties=JsonObject(3): -{"location":"\/dev\/null:1,1--1,1","is_intro":true,"name":"(self)"} +=properties=JsonObject(4): +{"location":"\/dev\/null:1,1--1,1","is_intro":true,"name":"(self)","mdoc":["A documented namespace."]} Edge =type=7:DEFINES @@ -179,8 +179,8 @@ Edge 3:foo 7:MEntity 6:MGroup -=properties=JsonObject(1): -{"name":"foo"} +=properties=JsonObject(2): +{"name":"foo","mdoc":["A documented namespace."]} ---- =to=Node =labels=Array(3): @@ -200,8 +200,8 @@ Edge 3:foo 7:MEntity 6:MClass -=properties=JsonObject(4): -{"kind":"class","visibility":"public","name":"(self)","location":"\/dev\/null:1,1--1,1"} +=properties=JsonObject(5): +{"kind":"class","visibility":"public","name":"(self)","mdoc":["A documented namespace."],"location":"\/dev\/null:1,1--1,1"} ---- =to=Entity#0: =labels=Array(4): @@ -231,8 +231,8 @@ Edge 3:foo 7:MEntity 6:MClass -=properties=JsonObject(4): -{"kind":"class","visibility":"public","name":"(self)","location":"\/dev\/null:1,1--1,1"} +=properties=JsonObject(5): +{"kind":"class","visibility":"public","name":"(self)","mdoc":["A documented namespace."],"location":"\/dev\/null:1,1--1,1"} Edge =type=9:BOUNDTYPE @@ -244,8 +244,8 @@ Edge 3:foo 7:MEntity 9:MClassDef -=properties=JsonObject(3): -{"location":"\/dev\/null:1,1--1,1","is_intro":true,"name":"(self)"} +=properties=JsonObject(4): +{"location":"\/dev\/null:1,1--1,1","is_intro":true,"name":"(self)","mdoc":["A documented namespace."]} ---- =to=Entity#0: =labels=Array(4): @@ -266,16 +266,16 @@ Edge 3:foo 7:MEntity 9:MClassDef -=properties=JsonObject(3): -{"location":"\/dev\/null:1,1--1,1","is_intro":true,"name":"(self)"} +=properties=JsonObject(4): +{"location":"\/dev\/null:1,1--1,1","is_intro":true,"name":"(self)","mdoc":["A documented namespace."]} ---- =to=Entity#0: =labels=Array(3): 3:foo 7:MEntity 6:MClass -=properties=JsonObject(4): -{"kind":"class","visibility":"public","name":"(self)","location":"\/dev\/null:1,1--1,1"} +=properties=JsonObject(5): +{"kind":"class","visibility":"public","name":"(self)","mdoc":["A documented namespace."],"location":"\/dev\/null:1,1--1,1"} Edge =type=10:INTRODUCES @@ -287,8 +287,8 @@ Edge 3:foo 7:MEntity 9:MClassDef -=properties=JsonObject(3): -{"location":"\/dev\/null:1,1--1,1","is_intro":true,"name":"(self)"} +=properties=JsonObject(4): +{"location":"\/dev\/null:1,1--1,1","is_intro":true,"name":"(self)","mdoc":["A documented namespace."]} ---- =to=Entity#0: =labels=Array(4): @@ -318,8 +318,8 @@ Edge 3:foo 7:MEntity 9:MClassDef -=properties=JsonObject(3): -{"location":"\/dev\/null:1,1--1,1","is_intro":true,"name":"(self)"} +=properties=JsonObject(4): +{"location":"\/dev\/null:1,1--1,1","is_intro":true,"name":"(self)","mdoc":["A documented namespace."]} Edge =type=8:DECLARES @@ -331,8 +331,8 @@ Edge 3:foo 7:MEntity 9:MClassDef -=properties=JsonObject(3): -{"location":"\/dev\/null:1,1--1,1","is_intro":true,"name":"(self)"} +=properties=JsonObject(4): +{"location":"\/dev\/null:1,1--1,1","is_intro":true,"name":"(self)","mdoc":["A documented namespace."]} ---- =to=Entity#0: =labels=Array(4): -- 1.7.9.5