Skip to content

Add a @Deprecated annotation #282

Description

@cglacet

I think it would be a nice addition to have a @Deprecated annotation.

Maybe something like this:

;| @Global
  The function F computes 2x
  @Deprecated
  @Param x \<int\> : how it changed
  @Return \<int\> double of x
|;
(defun f (x)
  (* x 2)
)

Which would generate something like:

Image

I generated this image using the following code, but it's a bit unstable (the @Deprecated should be on its own line, otherwise it will "eat" the description):

;| @Global
  @**Deprecated**
  The function F computes 2x
  @Param x \<int\> : how it changed
  @Return \<int\> double of x
|;
(defun f (x)
  (* x 2)
)

Maybe it would also be nice to have a deprecation message ? Like @Deprecated what to use instead.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions