diff options
author | Patrick Lehmann <Paebbels@gmail.com> | 2022-12-23 08:56:19 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-12-23 08:56:19 +0100 |
commit | 7763427a8d55963c056bba94f6b519dc3e78e739 (patch) | |
tree | 30f802cbe06f5ad70ec8aff224db6ab58efd3b93 /testsuite/pyunit/libghdl/examples/Complex.vhdl | |
parent | a52d811e4df70d7a02db6cec912ed6577c46acae (diff) | |
download | ghdl-7763427a8d55963c056bba94f6b519dc3e78e739.tar.gz ghdl-7763427a8d55963c056bba94f6b519dc3e78e739.tar.bz2 ghdl-7763427a8d55963c056bba94f6b519dc3e78e739.zip |
Testing complex documentation examples (#2275)
* Testing complex examples.
* Added comment annotations.
* Removed duplicated file.
Diffstat (limited to 'testsuite/pyunit/libghdl/examples/Complex.vhdl')
-rw-r--r-- | testsuite/pyunit/libghdl/examples/Complex.vhdl | 130 |
1 files changed, 0 insertions, 130 deletions
diff --git a/testsuite/pyunit/libghdl/examples/Complex.vhdl b/testsuite/pyunit/libghdl/examples/Complex.vhdl deleted file mode 100644 index 40eaa80ff..000000000 --- a/testsuite/pyunit/libghdl/examples/Complex.vhdl +++ /dev/null @@ -1,130 +0,0 @@ --- :e1: comments before desIgn units (javadoc / .net documentation style) --- :e1: mIGht be multiline -entity e1 is -end entitY; - --- :a1: comments before design units --- :a1: might be multiline -architecture a1 of e1 is -begin -end architecture; - --- :p1: comments before design units --- :p1: might be multiline -package p1 is -end package; - --- :ctx1: comments before design units --- :ctx1: might be multiline -context ctx1 is -end context; - --- :cfg1: comments before design units --- :cfg1: might be multiline -configuration cfg1 of e1 is - for a1 - end for; -end configuration; - - -library ieee; -use ieee.std_logic_1164.all; - -entity e2 is - -- :e2: comments in design units (python doc-string style) - -- :e2: might be multi line - generic ( - -- :FREQUENCY: comment before a generic - -- :FREQUENCY: might be multiline - constant FREQUENCY : positive; - constant BITS : positive; -- :BITS: comment after a generic are mostly single line, - -- :BITS: but could be multi line too - -- :BITS: in case comment is before and after - constant DEBUG : boolean -- :DEBUG: the after has presidency - ); - port ( - signal Clock : in std_logic -- :Clock: same as for generics - ); -end entity; - -architecture a2 of e2 is - -- :a2: comments in design units (python doc-string style) - -- :a2: might be multi line -begin - -end architecture; - --- :p2: As packages define public elements like constants, types and sub-programs, we are interested in such documentation too. -package p2 is - -- :p2: comments in design units (python doc-string style) - -- :p2: might be multi line - - -- :DEBUG: comment before - constant DEBUG : boolean := TRUE; - constant SYNC_STAGES : positive := 3; -- :SYNC_STAGES: comment after - - -- :AType1: comment before - type AType1 is array(natural range <>) of bit; - type AType2 is array(natural range <>) of bit; -- :AType2: comment after - - -- same applies to subtype, alias, attributes, ... - - -- :RType: comment before - type RType is record - -- :RType: xor comment inside - - -- :elem1: per element comment before (note the comment "block" is separated by newlines) - elem1 : integer; - elem2 : integer; -- :elem2: per element comment behind - end record; - - -- :log2: as functions are longer in definitions, it might be written before - function log2(param : positive) return natural; - - function log2( - -- :log2: otoh, we also want to document parameters too (similar to a record with comments) - - -- :param1: comment before - param1 : integer; - param2 : boolean -- :param2: comment after - ) return natural; - - -- this applies to procedures as well. - - - -end package; - -context ctx2 is - -- :ctx2: comments in design units (python doc-string style) - -- :ctx2: might be multi line -end context; - -configuration cfg2 of e2 is - -- :cfg2: comments in design units (python doc-string style) - -- :cfg2: might be multi line - for a2 - end for; -end configuration; - - - - - - - --- This should allow for any kind of documentation style and embedded documentation language. --- A real implementation might use similar rules are Python+docutils+Sphinx. Here we would e.g. --- document a function either before (or inside) a function declaration and use the --- :arg name: description --- syntax. - - --- :math: Package `math` provides math extensions not provided by the IEEE packages. -package math is - -- :log2: Computes the logarithm to base 2. - -- :log2: - -- :log2: :arg param: Input value - -- :log2: :returns: Logarithm - function log2(param : positive) return natural; -end package; |