From 38b2f44764e79a34048f686d98b6d741d18738d2 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Thu, 5 May 2011 14:22:18 +0200 Subject: Improve erl_docgen's support for Dialyzer specs and types The support for using Dialyzer specifications and types has been improved. --- lib/erl_docgen/priv/xsl/db_html.xsl | 556 +++++++++++++++++++++++++----------- lib/erl_docgen/priv/xsl/db_man.xsl | 424 ++++++++++++++++++--------- lib/erl_docgen/priv/xsl/db_pdf.xsl | 451 ++++++++++++++++++++--------- 3 files changed, 989 insertions(+), 442 deletions(-) (limited to 'lib/erl_docgen/priv/xsl') diff --git a/lib/erl_docgen/priv/xsl/db_html.xsl b/lib/erl_docgen/priv/xsl/db_html.xsl index c6375ea621..982572aeef 100644 --- a/lib/erl_docgen/priv/xsl/db_html.xsl +++ b/lib/erl_docgen/priv/xsl/db_html.xsl @@ -22,12 +22,15 @@ @@ -38,49 +41,58 @@ + - Error : - /: + Error in : + : + + /: - + - + - - + + + + + + ambiguous spec + unknown spec + + + - unknown spec + + + - - - - / - - - - - + + + + + + @@ -89,72 +101,189 @@ - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - + + - + + + +
- - + + + + + + + + + + + + + + + + + + + + +

Types:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ + + + -

Types:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + unknown type variable + + + + - - + + + + -
+
+ + + -
- + + + +
- + +
+
+ + + + + + + +
+ + + + + +
+ + +
@@ -193,130 +322,175 @@
- - - -
-
- - - -
- - -
-
- - -
- - - -
-
+ + + + - - - - - - - - - - + + + + ambiguous type + unknown type + + + - unknown type + - + + + + + + + + + + + - + - + + + + +
+
+ + + + + + + + + +
+
+ + + + +
+ + +
+
+ + + +
+ + + +
+
+ + select="ancestor::type_desc/preceding-sibling::name + | ancestor::desc/preceding-sibling::name"/> - cannot find 'name' () + + cannot find tag 'name' (anno ) - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + unknown annotation + + + + + + + + + + + + + + + + "$spec0[string-length($clause_i) = 0 + or position() = $clause_i]/anno[.=$anno]"/> - - - - - - - - - - - - - - - - - unknown annotation - - + + - @@ -324,6 +498,50 @@  
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1178,14 +1396,7 @@ - - - / - - - - - + @@ -1221,11 +1432,19 @@ -
  • - - / - -
  • + + + + + +
  • + + / + +
  • +
    +
    @@ -1470,7 +1689,10 @@ -

    +

    +

    @@ -1478,7 +1700,6 @@
    - @@ -1488,6 +1709,11 @@ + + + Error : arity is mandatory when referring to specifications! + + @@ -1556,12 +1782,17 @@ -

    Types:

    + + - - - -
    +

    Types:

    + + + + +
    + +
    @@ -1612,7 +1843,10 @@
    + + + @@ -1633,16 +1867,16 @@ --> - + - + - + diff --git a/lib/erl_docgen/priv/xsl/db_man.xsl b/lib/erl_docgen/priv/xsl/db_man.xsl index 2a8fb9fe3e..25b62f68c5 100644 --- a/lib/erl_docgen/priv/xsl/db_man.xsl +++ b/lib/erl_docgen/priv/xsl/db_man.xsl @@ -3,7 +3,7 @@ # # %CopyrightBegin% # - # Copyright Ericsson AB 2009-2010. All Rights Reserved. + # Copyright Ericsson AB 2009-2011. All Rights Reserved. # # The contents of this file are subject to the Erlang Public License, # Version 1.1, (the "License"); you may not use this file except in @@ -21,13 +21,16 @@ --> + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:exsl="http://exslt.org/common" + extension-element-prefixes="exsl"> - @@ -35,38 +38,58 @@ + - Error : - /: + Error in : + : + + /: - + - + - - + + + + + + ambiguous spec + unknown spec + + + - unknown spec + + + + + + + + + + + @@ -75,42 +98,12 @@ - - - - - - - - - - + .br - - - - - - - - - - - - - - - - - - - - - .nf .B @@ -119,29 +112,141 @@ .fi - - + + + + + + + + + + + + + + + + + + + + .RS + .TP + Types + + + + + + + + + + + + + + + + + + + + + + + + + + .RE + + + + + + + - .RS - .TP - Types - - - - - .RE + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + unknown type variable + + + + + + + + + + - - - - .br - + + + .br + + + + + + + + + + + + + + .br + + + @@ -164,59 +269,46 @@ - - .nf - .B - - .br - .fi - - - - .RS - - .RE - - - - - - .br - - + - - - - - - - - - - + + + + ambiguous type + unknown type + + + - unknown type + - + + + + + + + + - + .nf .B @@ -226,68 +318,109 @@ + + .nf + .B + + .br + .fi + + + + .nf + + .fi + + + + + .RS + + .RE + + + + + + .br + + + select="ancestor::type_desc/preceding-sibling::name + | ancestor::desc/preceding-sibling::name"/> - cannot find 'name' () + + cannot find tag 'name' (anno ) - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + unknown annotation + + + + + + + + + + + + + + + + "$spec0[string-length($clause_i) = 0 + or position() = $clause_i]/anno[.=$anno]"/> - - - - - - - - - - - - - - - - - unknown annotation - - + + - @@ -542,6 +675,9 @@ .LP + @@ -554,6 +690,11 @@ + + + Error : arity is mandatory when referring to specifications! + + @@ -569,11 +710,14 @@ - .RS - .TP - Types - - .RE + + + .RS + .TP + Types + + .RE + @@ -622,7 +766,7 @@ > - + diff --git a/lib/erl_docgen/priv/xsl/db_pdf.xsl b/lib/erl_docgen/priv/xsl/db_pdf.xsl index f500cd3fee..5119e3e36a 100644 --- a/lib/erl_docgen/priv/xsl/db_pdf.xsl +++ b/lib/erl_docgen/priv/xsl/db_pdf.xsl @@ -21,6 +21,8 @@ --> @@ -28,45 +30,66 @@ + - Error : - /: + Error in : + : + + /: - + - + - - + + + + + + ambiguous spec + unknown spec + + + - unknown spec + + + + + + + + + + + @@ -76,78 +99,175 @@ - - - - - - - - - - + - - - - - + + + + - - + + + + + + + + + + - - - - - + + + + + + + + + + Types: + + + + + + + + + + + + + + + + + + + + + + + + - - + + - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + unknown type variable + + + - - - Types: - - - - + + - + + + - - - + + - + + + + + + + + + + + + + + + + + + + + + + + + + @@ -182,6 +302,53 @@ + + + + + + + + + + + + + + + ambiguous type + unknown type + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -189,6 +356,20 @@ + + + + + + + + + @@ -211,108 +392,82 @@ - - - - - - - - - - - - - - - - - - - - - - - - - unknown type - - - - - - - - - - - - + select="ancestor::type_desc/preceding-sibling::name + | ancestor::desc/preceding-sibling::name"/> - cannot find 'name' () + + cannot find tag 'name' (anno ) - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + unknown annotation + + + + + + + + + + + + + + + + "$spec0[string-length($clause_i) = 0 + or position() = $clause_i]/anno[.=$anno]"/> - - - - - - - - - - - - - - - - - unknown annotation - - + + - @@ -1227,6 +1382,9 @@ + @@ -1245,6 +1403,11 @@ + + + Error : arity is mandatory when referring to specifications! + + @@ -1276,15 +1439,20 @@ - - Types: - + + - - - - - + + Types: + + + + + + + + + @@ -1431,6 +1599,7 @@ + -- cgit v1.2.3