Skip to content

doc: correct inheritdoc natspec tags #90

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 18, 2025
Merged

doc: correct inheritdoc natspec tags #90

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/XanV1.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ contract XanV1 is
votingData.scheduledEndTime = 0;
}

/// @notice @inheritdoc IXanV1
/// @inheritdoc IXanV1
function scheduleCouncilUpgrade(address impl) external override onlyCouncil {
// Revert if a voter-body upgrade could be scheduled
{
Expand All @@ -255,7 +255,7 @@ contract XanV1 is
emit CouncilUpgradeScheduled(councilData.scheduledImpl, councilData.scheduledEndTime);
}

/// @notice @inheritdoc IXanV1
/// @inheritdoc IXanV1
function cancelCouncilUpgrade() external override onlyCouncil {
Council.Data storage councilData = _getCouncilData();

Expand All @@ -271,7 +271,7 @@ contract XanV1 is
councilData.scheduledEndTime = 0;
}

/// @notice @inheritdoc IXanV1
/// @inheritdoc IXanV1
function vetoCouncilUpgrade() external override {
Council.Data storage councilData = _getCouncilData();

Expand Down Expand Up @@ -302,17 +302,17 @@ contract XanV1 is
votes = _getVotingData().ballots[proposedImpl].votes[voter];
}

/// @notice @inheritdoc IXanV1
/// @inheritdoc IXanV1
function mostVotedImplementation() external view override returns (address mostVotedImpl) {
mostVotedImpl = _getVotingData().mostVotedImpl;
}

/// @notice @inheritdoc IXanV1
/// @inheritdoc IXanV1
function lockedSupply() public view override returns (uint256 locked) {
locked = _getLockingData().lockedSupply;
}

/// @notice @inheritdoc IXanV1
/// @inheritdoc IXanV1
function calculateQuorumThreshold() public view override returns (uint256 threshold) {
threshold = (lockedSupply() * Parameters.QUORUM_RATIO_NUMERATOR) / Parameters.QUORUM_RATIO_DENOMINATOR;
}
Expand All @@ -322,7 +322,7 @@ contract XanV1 is
votes = _getVotingData().ballots[proposedImpl].totalVotes;
}

/// @notice @inheritdoc IXanV1
/// @inheritdoc IXanV1
function implementation() public view override returns (address thisImplementation) {
thisImplementation = ERC1967Utils.getImplementation();
}
Expand Down