package ecaml

  1. Overview
  2. Docs
package ecaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
type 'a t
val sexp_of_t : ('a -> Ppx_sexp_conv_lib.Sexp.t) -> 'a t -> Ppx_sexp_conv_lib.Sexp.t

A property of an Emacs symbol.

(Info-goto-node "(elisp)Symbol Properties")

val create : symbol -> 'a Ecaml_value.Value.Type.t -> 'a t

Create a property named by the given symbol.

val get : 'a t -> symbol -> 'a option

(describe-function 'get)

val get_exn : 'a t -> symbol -> 'a

(describe-function 'get)

val put : 'a t -> symbol -> 'a -> unit

(describe-function 'put)

val function_documentation : Ecaml_value.Value.t t

According to (Info-goto-node "(elisp)Documentation Basics"), there are two places where one can put a documentation string:

1. in the lambda after the arg list, or 2. in the function symbol's function-documentation property

Most functions use (1), but some use (2), e.g. a defalias like abbrev-get or an advised function like next-error.

val variable_documentation : Ecaml_value.Value.t t