new annotations

[fchastanet]

Hello,

first thanks for your project I added some features with unit tests included

new annotations

• added @warning with badge
• added @constraint
• added @require
• added @feature with badge
• added @deprecated with badge
• added @trap
• added @env

The badge feature forced me to add an urlencode function to construct valid links

One little change

• updated @example allowing to change default script language

I also updated README.md example, removing the table because actually I discovered the rendered file viewing at source code. The scrollbar on the table on github website was hiding the comparison.

Do not hesitate to give me your feedbacks

[hyperupcall]

Glad to see @deprecated supported (that would close my issue #46). One thing I'd like to add is that if it were me, I wouldn't want a badge to show for deprecated functions - just regular text somewhere - would be nice. That way, it aligns with all the other features - being text-only and showing without an internet connection.

[fchastanet]

Glad to see @deprecated supported (that would close my issue #46). One thing I'd like to add is that if it were me, I wouldn't want a badge to show for deprecated functions - just regular text somewhere - would be nice. That way, it aligns with all the other features - being text-only and showing without an internet connection.

Thanks for the suggestion, actually it could be easily to implement it using a different style, as I implemented it in github style, it makes sense to implement it as a github badge.

Maybe you could create your own style starting from this branch.

[hyperupcall]

When testing this change, I had trouble keeping the badge for @deprecated when @description was also specified. For example, the following:

# @name Project Name
# @brief Brief
# @description overview

# @description My super function. Not thread safe.
# @deprecated use some other thing instead
b() {
    :
}

results in:

# Project Name

Brief

## Overview

overview

## Index

* [b](#b)

### b

My super function. Not thread safe.
@deprecated use some other thing instead

[fchastanet]

When testing this change, I had trouble keeping the badge for @deprecated when @description was also specified. For example, the following:

Thanks to have reported it with a reproductible test case, I fixed it, you can check my commit https://github.com/reconquest/shdoc/pull/70/commits/1f386d0e6e0dfca4baf1d8d1b05be1c6c74a7de2