Skip to content
This repository
tree: f008678a2b
Fetching contributors…

Cannot retrieve contributors at this time

file 71 lines (62 sloc) 1.899 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
/*
Copyright © 2011 MLstate

This file is part of OPA.

OPA is free software: you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License, version 3, as published by
the Free Software Foundation.

OPA is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for
more details.

You should have received a copy of the GNU Affero General Public License
along with OPA. If not, see <http://www.gnu.org/licenses/>.
*/

/**
* Arguments for tagging part of the code as deprecated.
**/

/**
* {1 About this module}
*
* This module defines the type of the argument of the directive @deprecated
*
* These arguments are read at compile time, and should use literal only.
* @see pass_CodingDirectives
* @see opa parser
*
* {1 Where should I start?}
*
* Here are some example of use:
*
* {[
* @deprecated({use="bar"}) foo = bar
* }
*
* {[
* @deprecated({hint="Please refactor your code, this function does no longer exists"}) foo = ...
* }
*
* {1 What if I need more?}
*/

/**
* {1 Types defined in this module}
*/

/**
* Argument of the @deprecated directive
* You cannot modify this code without patching the pass_CodingDirectives.
**/
@opacapi
type Deprecated.argument =
   /**
* {[
* @deprecated({use="this_function"}) deprec_fun() = void
* do deprec_fun()
* }
* will produce a warning around the utilization of the deprec_fun, telling :
* {This code uses a deprecated construction. Please use "this_function" instead}
**/
   { use : string }

   /**
* This argument is used if there is no new function to use instead.
* The string is them a comment, giving an hint to explain
**/
 / { hint : string }
Something went wrong with that request. Please try again.