From 3309be9108dc37f8478d6ff785165dd787453ccc Mon Sep 17 00:00:00 2001 From: Jean Privat Date: Fri, 19 Sep 2014 15:09:59 -0400 Subject: [PATCH] modelize: advice on missing documentation Signed-off-by: Jean Privat --- src/modelbuilder.nit | 2 ++ src/modelize/modelize_class.nit | 2 ++ src/modelize/modelize_property.nit | 2 ++ 3 files changed, 6 insertions(+) diff --git a/src/modelbuilder.nit b/src/modelbuilder.nit index 69dd2bf..48bc6fa 100644 --- a/src/modelbuilder.nit +++ b/src/modelbuilder.nit @@ -630,6 +630,8 @@ class ModelBuilder var mdoc = ndoc.to_mdoc mmodule.mdoc = mdoc mdoc.original_mentity = mmodule + else + advice(decl, "missing-doc", "Documentation warning: Undocumented module `{mmodule}`") end end diff --git a/src/modelize/modelize_class.nit b/src/modelize/modelize_class.nit index ed4df60..8bc6ef2 100644 --- a/src/modelize/modelize_class.nit +++ b/src/modelize/modelize_class.nit @@ -182,6 +182,8 @@ redef class ModelBuilder var mdoc = ndoc.to_mdoc mclassdef.mdoc = mdoc mdoc.original_mentity = mclassdef + else if mclassdef.is_intro and mclass.visibility >= public_visibility then + advice(nclassdef, "missing-doc", "Documentation warning: Undocumented public class `{mclass}`") end end diff --git a/src/modelize/modelize_property.nit b/src/modelize/modelize_property.nit index bf54e73..2e7af1b 100644 --- a/src/modelize/modelize_property.nit +++ b/src/modelize/modelize_property.nit @@ -418,6 +418,8 @@ redef class APropdef var mdoc = ndoc.to_mdoc mpropdef.mdoc = mdoc mdoc.original_mentity = mpropdef + else if mpropdef.is_intro and mpropdef.mproperty.visibility >= protected_visibility then + modelbuilder.advice(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`") end var at_deprecated = get_single_annotation("deprecated", modelbuilder) -- 1.7.9.5