From 984c12ae146812dd8da7d04cb8983f3afbc81bb6 Mon Sep 17 00:00:00 2001
From: Valentin Villenave <valentin@villenave.net>
Date: Fri, 5 Mar 2010 14:17:06 +0100
Subject: [PATCH] Doc: add doc-strings to music-functions

The \harmonicsO[n|ff] commands have been
rewritten as music-functions, to be more
like other definitions such as \palmMute.

This commit also adds a \harmonicNote command,
for consistency's sake with \deadNote etc.,
and a \defaultNoteHeads that acts as a common
definition for all note head styles reverting
(i.e. \deadNoteOff, \harmonicsOff etc.).
---
 ly/music-functions-init.ly |  3 ++-
 ly/property-init.ly        | 31 +++++++++++++++++++++++--------
 2 files changed, 25 insertions(+), 9 deletions(-)

diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index d3d14e7f37..f49797ec81 100644
--- a/ly/music-functions-init.ly
+++ b/ly/music-functions-init.ly
@@ -379,7 +379,8 @@ makeClusters =
 
 musicMap =
 #(define-music-function (parser location proc mus) (procedure? ly:music?)
-	     (music-map proc mus))
+    (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
+    (music-map proc mus))
 
 
 
diff --git a/ly/property-init.ly b/ly/property-init.ly
index 954dae2b5f..21644f2d71 100644
--- a/ly/property-init.ly
+++ b/ly/property-init.ly
@@ -6,6 +6,14 @@
 #(define (make-simple-dash-definition dash-fraction dash-period)
     (list (list 0 1 dash-fraction dash-period)))
 
+%% common definition for all note head styles reverting
+%% (palm mute, harmonics, dead notes, ...)
+defaultNoteHeads=
+#(define-music-function (parser location) ()
+   (_i "Revert to the default note head style.")
+   (revert-head-style 'NoteHead))
+
+
 
 %% arpeggios
 
@@ -198,8 +206,15 @@ glissando = #(make-music 'GlissandoEvent)
 
 %% harmonics
 
-harmonicsOn  = \override NoteHead #'style = #'harmonic
-harmonicsOff = \revert NoteHead #'style
+harmonicsOn =
+#(define-music-function (parser location) ()
+   (_i "Set the default note head style to a diamond-shaped style.")
+   (override-head-style 'NoteHead 'harmonic))
+harmonicsOff = \defaultNoteHeads
+harmonicNote =
+#(define-music-function (parser location note) (ly:music?)
+   (_i "Print @var{note} with a diamond-shaped note head.")
+   (style-note-heads 'NoteHead 'harmonic note))
 
 
 %% hideNotes
@@ -259,12 +274,12 @@ defaultTimeSignature = \revert Staff.TimeSignature #'style
 
 palmMuteOn =
 #(define-music-function (parser location) ()
+   (_i "Set the default note head style to a triangle-shaped style.")
    (override-head-style 'NoteHead 'do))
-palmMuteOff =
-#(define-music-function (parser location) ()
-   (revert-head-style 'NoteHead))
+palmMuteOff = \defaultNoteHeads
 palmMute =
 #(define-music-function (parser location note) (ly:music?)
+   (_i "Print @var{note} with a triangle-shaped note head.")
    (style-note-heads 'NoteHead 'do note))
 
 
@@ -533,12 +548,12 @@ voiceNeutralStyle = {
 
 xNotesOn =
 #(define-music-function (parser location) ()
+   (_i "Set the default note head style to a cross-shaped style.")
    (override-head-style '(TabNoteHead NoteHead) 'cross))
-xNotesOff =
-#(define-music-function (parser location) ()
-   (revert-head-style '(TabNoteHead NoteHead)))
+xNotesOff = \defaultNoteHeads
 xNote =
 #(define-music-function (parser location note) (ly:music?)
+   (_i "Print @var{note} with a cross-shaped note head.")
    (style-note-heads '(TabNoteHead NoteHead) 'cross note))
 
 
-- 
2.39.2