Skip to content

Commit

Permalink
Link to annotations documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Y-Less authored Nov 6, 2023
1 parent 79de239 commit 9ce061b
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions YSI_Server/y_decorator/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
## Example 1
## Introduction

This library makes one aspect of writing ["decorators" (aka "annotations"](https://github.com/pawn-lang/YSI-Includes/blob/5.x/annotations.md) simpler. This gives compile-time analysis of function parameter types and provides them to your decorator automatically. For more advanced analysis you should use [code-parse.inc](https://github.com/Y-Less/code-parse.inc), which this library uses underneath.

### Example 1

To write an `@example()` decorator that just lists all the functions with this decorator on server start, plus their parameter types.

Expand Down Expand Up @@ -44,7 +48,7 @@ Now we need to actually do something with all this data. To run some code at se
#define DECORATOR_EXAMPLE:%8$(%0)(%1)(%2)(%3)(%4)(%5) %8$@init %2() printf("Function %s, with parameters %s, decorated", __nameof(%2), #%4); %1%2(%3)
```

## Example 2
### Example 2

We can make a function called remotely with:

Expand Down

0 comments on commit 9ce061b

Please sign in to comment.