Add TYPEDFIELDS to display field names (#77)

Author: Richard Palethorpe (rpalethorpe)

src/DocStringExtensions.jl

@@ -77,7 +77,8 @@ module DocStringExtensions
 
 # Exports.
 
-export @template, FIELDS, EXPORTS, METHODLIST, IMPORTS, SIGNATURES, TYPEDSIGNATURES, TYPEDEF, DOCSTRING, FUNCTIONNAME
+export @template, FIELDS, TYPEDFIELDS, EXPORTS, METHODLIST, IMPORTS
+export SIGNATURES, TYPEDSIGNATURES, TYPEDEF, DOCSTRING, FUNCTIONNAME
 export README, LICENSE
 
 # Includes.

src/abbreviations.jl

@@ -35,11 +35,13 @@ Docs.formatdoc(buf::IOBuffer, doc::Docs.DocStr, part::Abbreviation) = format(par
 #
 
 """
-The singleton type for [`FIELDS`](@ref) abbreviations.
+The type for [`FIELDS`](@ref) abbreviations.
 
 $(:FIELDS)
 """
-struct TypeFields <: Abbreviation end
+struct TypeFields <: Abbreviation
+    types::Bool
+end
 
 """
 An [`Abbreviation`](@ref) to include the names of the fields of a type as well as any
@@ -64,9 +66,33 @@ attached.
     Another documented field.
 ```
 """
-const FIELDS = TypeFields()
+const FIELDS = TypeFields(false)
+
+"""
+Identical to [`FIELDS`](@ref) except that it includes the field types.
+
+# Examples
+
+The generated markdown text should look similar to to following example where
+a type has three fields; `x` of type `String`, `y` of type `Int`, and `z` of
+type `Vector{Any}`.
+
+```markdown
+
+  - `x::String`
+
+  - `y::Int`
 
-function format(::TypeFields, buf, doc)
+    Unlike the `x` field this field has been documented.
+
+  - `z::Array{Any, 1}`
+
+    Another documented field.
+```
+"""
+const TYPEDFIELDS = TypeFields(true)
+
+function format(abbrv::TypeFields, buf, doc)
     local docs = get(doc.data, :fields, Dict())
     local binding = doc.data[:binding]
     local object = Docs.resolve(binding)
@@ -76,7 +102,11 @@ function format(::TypeFields, buf, doc)
     if !isempty(fields)
         println(buf)
         for field in fields
-            print(buf, "  - `", field, "`\n")
+            if abbrv.types
+                println(buf, "  - `", field, "::", fieldtype(object, field), "`")
+            else
+                println(buf, "  - `", field, "`")
+            end
             # Print the field docs if they exist and aren't a `doc"..."` docstring.
             if haskey(docs, field) && isa(docs[field], AbstractString)
                 println(buf)

test/tests.jl

@@ -99,6 +99,14 @@ end
             @test occursin("  - `c`", str)
             @test occursin("one", str)
             @test occursin("two", str)
+
+            DSE.format(TYPEDFIELDS, buf, doc)
+            str = String(take!(buf))
+            @test occursin("  - `a::Any`", str)
+            @test occursin("  - `b::Any`", str)
+            @test occursin("  - `c::Any`", str)
+            @test occursin("one", str)
+            @test occursin("two", str)
         end
 
         @testset "method lists" begin