package ecaml

  1. Overview
  2. Docs
package ecaml
Legend:
Library
Module
Module type
Parameter
Class
Class type

(Info-goto-node "(emacs)Comments")

Note: these are functions rather than Var.ts because per-buffer initialization is required before these variables are known to be correct.

val start : unit -> string

(describe-variable 'comment-start) (Info-goto-node "(emacs)Options for Comments")

val start_regexp : unit -> Regexp.t

(describe-variable 'comment-start-skip) (Info-goto-node "(emacs)Options for Comments")

val end_ : unit -> string

(describe-variable 'comment-end) (Info-goto-node "(emacs)Options for Comments")

val end_regexp : unit -> Regexp.t

(describe-variable 'comment-end-skip) (Info-goto-node "(emacs)Options for Comments")

val multi_line : unit -> bool

(describe-variable 'comment-multi-line) (Info-goto-node "(emacs)Options for Comments")

val set_current_buffer_options : start:string -> end_:string -> is_multi_line:bool -> unit
val beginning : unit -> Position.t option

Move the point to the beginning of the current comment, and return the position of the comment starter.

(describe-function 'comment-beginning)

val bounds_of_comment_at_point : unit -> (Position.t * Position.t) option

Return Some (beginning, end_) if the point is in a comment, or None otherwise.

The region delimited by the returned positions contains the entire comment, including the comment start and end markers (e.g., /* and */ in C-like languages).

Note: the goto_* functions below differ from their newcomment.el brethren in that they work correctly when point is inside the comment delimiter text.

val goto_beginning_exn : unit -> unit

Assuming the point is currently in a comment, move to the beginning of its content.

val goto_end_exn : unit -> unit

Assuming the point is currently in a comment, move to the end of its content.

module Terminated_by : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct