From 9e8a78541d51083ec32f81ed7e5bc8b3992b6bdc Mon Sep 17 00:00:00 2001 From: Masatake YAMATO Date: Tue, 4 May 2021 02:45:34 +0900 Subject: [PATCH] docs(web): introduce new terms corkQueue and corkIndex Signed-off-by: Masatake YAMATO --- docs/internal.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/internal.rst b/docs/internal.rst index 2775902d91..d472ccae1d 100644 --- a/docs/internal.rst +++ b/docs/internal.rst @@ -98,9 +98,10 @@ parser does not set ``CORK_QUEUE`` to ``useCork`` field. ``writeTagEntry`` calls xrefWriter, and jsonWriter. One of them is chosen depending on the arguments passed to ctags. -If ``CORK_QUEUE`` is set to ``useCork``, the tag information goes to a queue on memory. -The queue is flushed when ``useCork`` in unset. See "`cork API`_" for more -details. +If ``CORK_QUEUE`` is set to ``useCork``, the tag information goes to a +queue (**corkQueue**) on memory, and a unique integer (**corkIndex**) +is assigned identifying the tag information. The queue is flushed +when ``useCork`` in unset. See "`cork API`_" for more details. cork API ......................................................................