From 9e43525077697e75244d1275ec0ba88a7c2ed7f9 Mon Sep 17 00:00:00 2001 From: Damien Cassou Date: Sat, 4 Feb 2017 08:09:44 +0100 Subject: [PATCH] * lisp/auth-source.el: Document parser functions. --- lisp/auth-source.el | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/lisp/auth-source.el b/lisp/auth-source.el index 5ad42772f94..3b60bd88d55 100644 --- a/lisp/auth-source.el +++ b/lisp/auth-source.el @@ -353,12 +353,15 @@ with \"[a/b/c] \" if CHOICES is \(?a ?b ?c)." k))) (defvar auth-source-backend-parser-functions nil - "List of auth-source parser functions -These functions return backends from an entry in `auth-sources'. -Add your backends to this list with `add-hook'.") + "List of auth-source parser functions. +Each function takes an entry from `auth-sources' as parameter and +returns a backend or nil if the entry is not supported. Add a +parser function to this list with `add-hook'. Searching for a +backend starts with the first element on the list and stops as +soon as a function returns non-nil.") (defun auth-source-backend-parse (entry) - "Creates an auth-source-backend from an ENTRY in `auth-sources'." + "Create an auth-source-backend from an ENTRY in `auth-sources'." (let (backend) (dolist (f auth-source-backend-parser-functions) -- 2.39.5