branch: scratch/editorconfig-cc
commit ae8028cf3d5224d025360bf36951dd17cb4727d1
Author: 10sr <8.slas...@gmail.com>
Commit: Stefan Monnier <monn...@iro.umontreal.ca>
Add struct docstring
---
editorconfig-core-handle.el | 35 ++++++++++++++++++++++++-----------
1 file changed, 24 insertions(+), 11 deletions(-)
diff --git a/editorconfig-core-handle.el b/editorconfig-core-handle.el
index f6120689f3..c22172b56d 100644
--- a/editorconfig-core-handle.el
+++ b/editorconfig-core-handle.el
@@ -40,10 +40,16 @@
"Hash of EditorConfig filename and its `editorconfig-core-handle' instance.")
(cl-defstruct editorconfig-core-handle-section
- ;; String of section name (glob string)
+ "Structure representing one section in a .editorconfig file.
+
+Slots:
+
+`name'
+ String of section name (glob string).
+
+`props'
+ Alist of properties: (KEY . VALUE)."
(name nil)
- ;; Alist of properties
- ;; (KEY . VALUE)
(props nil))
(defun editorconfig-core-handle-section-get-properties (section file dir)
@@ -58,17 +64,24 @@ IF not match, return nil."
(editorconfig-core-handle-section-props section)))
(cl-defstruct editorconfig-core-handle
- ;; Alist of top propetties
- ;; e.g. (("root" . "true"))
- (top-props nil)
+ "Structure representing an .editorconfig file.
- ;; List of editorconfig-core-handle-section
- (sections nil)
+Slots:
+`top-props'
+ Alist of top propetties like ((\"root\" . \"true\"))
- ;; e.g. (22310 59113 203882 991000)
- (mtime nil)
+`sections'
+ List of `editorconfig-core-hadnle-section' strucure object.
+
+`mtime'
+ Last modified time of .editorconfig file.
- ;; e.g. "/home/a/b/.editorconfig"
+`path'
+ Absolute path to .editorconfig file.'
+"
+ (top-props nil)
+ (sections nil)
+ (mtime nil)
(path nil))
