Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NatSpec annotations not supported #1524

Closed
BenTheKush opened this issue Sep 14, 2023 · 0 comments · Fixed by #1529
Closed

NatSpec annotations not supported #1524

BenTheKush opened this issue Sep 14, 2023 · 0 comments · Fixed by #1529

Comments

@BenTheKush
Copy link
Contributor

BenTheKush commented Sep 14, 2023

Describe the bug
The Solidity docs describe NatSpec which allows annotations of the form "@custom:<name>".

I've documented this bug in this repository, but here are the details:

issue1524.sol:

// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.0;

/** 
 * The following example is taken from solidity docs:
 * https://docs.soliditylang.org/en/v0.8.17/natspec-format.html#documentation-example
 */

/// @title A simulator for trees
/// @author Larry A. Gardner
/// @notice You can use this contract for only the most basic simulation
/// @dev All function calls are currently implemented without side effects
/// @custom:experimental This is an experimental contract.
library Issue1524 {
}

Running solang fails

$  solang compile --target solana issue1524.sol 
error: tag '@custom:experimental' is not valid for contract
   ┌─ /Users/benku/Playground/issue1524.sol:13:6
   │
13 │ /// @custom:experimental This is an experimental contract.
   │      ^^^^^^^^^^^^^^^^^^^^

solang version v0.3.0
revision: "70af554c42748009e414e6263dd4607fb380e5dc"

seanyoung added a commit to seanyoung/solang that referenced this issue Sep 14, 2023
Fixes hyperledger-solang#1524

Signed-off-by: Sean Young <sean@mess.org>
seanyoung added a commit that referenced this issue Sep 15, 2023
Fixes #1524

Signed-off-by: Sean Young <sean@mess.org>
stainless-app bot pushed a commit to 2lambda123/hyperledger-solang that referenced this issue Feb 4, 2024
Fixes hyperledger-solang/solang#1524

Signed-off-by: Sean Young <sean@mess.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant