Commit Graph

35 Commits

Author SHA1 Message Date
Marenz
7f65f1cc02 Fix code-start headers in documentation 2021-07-01 15:17:42 +02:00
William Entriken
b2ef1a46a4
Allow NatSpec to apply to Libraries just as Contracts 2021-05-14 00:08:18 -04:00
William Entriken
88e33c9ea3
Match @return word styling to match @param (i.e. sentence case) 2021-05-08 01:14:22 -04:00
Alex Beregszaszi
a99e0eb5cb Move improvements to the NatSpec documentation 2021-03-30 22:09:21 +01:00
Christian Parpart
10ec49ddb9 Adds @custom:.... natspec example to the natspec-format documentation.
Co-authored-by: Harikrishnan Mulackal <webmail.hari@gmail.com>
2021-03-25 13:00:01 +01:00
Alex Beregszaszi
78a66787d4 Improve documentation about NatSpec
Clarify the connection to Doxygen.
2021-03-24 16:14:48 +00:00
Alex Beregszaszi
b477a7d163 Document the version/kind fields in the natspec documentation 2021-03-17 16:04:59 +00:00
chriseth
ecdeb417c5 Documentation. 2021-03-02 16:53:31 +01:00
chriseth
561280a5cc Merge remote-tracking branch 'origin/develop' into breaking 2020-12-14 11:33:40 +01:00
Kamil Śliwak
0f6f4314b6 Fix code snippets in docs not passing tests on versions matching their pragmas 2020-12-12 04:52:16 +01:00
Mathias Baumann
b72fb1333b Adjust docs example to work with v0.8.0 2020-09-08 13:36:16 +02:00
Kamil Śliwak
af482558cf natspec-format.rst: Update broken link to "Contract ABI" 2020-08-31 14:10:18 +02:00
Kamil Śliwak
9325c4ee99 docs: Update broken external links to point at new locations 2020-08-31 12:46:45 +02:00
Kamil Śliwak
89c99800d0 docs: Fix solidity code blocks by using the capitalized name
- This only works with `Solidity`, not with `solidity`.
2020-08-06 14:45:58 +02:00
chriseth
9be5ed1220 Merge remote-tracking branch 'origin/develop' into breaking 2020-07-21 11:35:28 +02:00
Mathias Baumann
ba0a4de50d NatSpec: Implement `@inheritdoc` 2020-07-20 18:32:18 +02:00
chriseth
3e3f9a472f Merge remote-tracking branch 'origin/develop' into breaking 2020-06-30 18:56:51 +02:00
Mathias Baumann
c50f0ae00e NatSpec: Implement default inheritance. 2020-06-30 14:45:13 +02:00
Mathias Baumann
fe33891531 Natspec: Add warning when using @author with functions 2020-06-29 18:10:36 +02:00
Harikrishnan Mulackal
4146ff9fcf NatSpec for events 2020-06-26 15:06:43 +05:30
chriseth
74b9b094c0 Merge remote-tracking branch 'origin/develop' into HEAD 2020-05-20 17:22:47 +02:00
Alexander Arlt
af8bb5fb60 Allow natspec comments on state variables. 2020-05-19 11:01:52 -05:00
William Entriken
3e8b9bdb1c Add NatSpec for public state variables 2020-05-19 11:01:52 -05:00
chriseth
257bc6a416 Merge remote-tracking branch 'origin/develop' into breaking 2020-05-14 13:04:46 +02:00
chriseth
d33b67b3c2 Add license tags to documentation snippets. 2020-05-13 22:16:34 +02:00
chriseth
6728e3ef94 Merge remote-tracking branch 'origin/develop' into breaking 2020-04-22 17:21:32 +02:00
iamdefinitelyahuman
d59706e5f5 docs: fix formatting errors and style inconsistencies 2020-04-20 20:24:31 +04:00
Erik Kundt
fe1676203d Updates documentation to 0.7.0. 2020-01-10 18:56:38 +01:00
chriseth
6cdda54ce1 Update natspec 2019-12-12 16:53:25 +01:00
chriseth
d8d8493550 Fix pragma version for testing. 2019-10-28 12:36:39 +01:00
Erik Kundt
ec53899a10 Fixes source extraction from docs. 2019-10-23 22:13:24 +02:00
cgrigis
7047ff1c3c
Minor typo 2019-07-25 10:58:45 +02:00
Chris Ward
7e4896740d Clarify that public applies to state variables 2019-06-17 16:55:31 +01:00
Fabio Bonfiglio
2a2f068542
Correct assigned value in natspec example 2019-06-13 13:12:32 +02:00
William Entriken
916e151f46 Add NatSpec documentation. 2019-04-19 00:54:08 +02:00