X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Faction%2Faction.h;h=f3f8d9deef0f16722a668f6e109b24547076c69a;hb=ab5be9fa2eb5ba9600a82cd18fd3cfcbac69169a;hp=311f5a0fb2924872dde21c4e59df4998f3d075a4;hpb=a58c490f0bff52a73717d31d04d1472629180de2;p=lttng-tools.git

diff --git a/include/lttng/action/action.h b/include/lttng/action/action.h
index 311f5a0fb..f3f8d9dee 100644
--- a/include/lttng/action/action.h
+++ b/include/lttng/action/action.h
@@ -1,18 +1,8 @@
 /*
- * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * This library is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License, version 2.1 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: LGPL-2.1-only
  *
- * This library is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
- * for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this library; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #ifndef LTTNG_ACTION_H
@@ -29,9 +19,17 @@ enum lttng_action_type {
 	LTTNG_ACTION_TYPE_NOTIFY = 0,
 };
 
+/*
+ * Get the type of an action.
+ *
+ * Returns the type of an action on success, LTTNG_ACTION_TYPE_UNKNOWN on error.
+ */
 extern enum lttng_action_type lttng_action_get_type(
 		struct lttng_action *action);
 
+/*
+ * Destroy (frees) an action object.
+ */
 extern void lttng_action_destroy(struct lttng_action *action);
 
 #ifdef __cplusplus