nautilus/libnautilus-extension/nautilus-column.h
Ondrej Holy fbbfa749bd column: Remove extra newline from documentation comment
Currently, the `Nautilus: "@name" parameter unexpected at this location`
warning is shown during build. This is caused by the extra newline character
in the documentation comment for the `nautilus_column_new` function. Let's
remove this extra newline character to get rid of that warning.
2023-03-29 13:43:10 +00:00

67 lines
2.2 KiB
C

/*
* nautilus-column.h - Info columns exported by
* NautilusColumnProvider objects.
*
* Copyright (C) 2003 Novell, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, see <http://www.gnu.org/licenses/>.
*
* Author: Dave Camp <dave@ximian.com>
*
*/
#pragma once
#if !defined (NAUTILUS_EXTENSION_H) && !defined (NAUTILUS_COMPILATION)
#warning "Only <nautilus-extension.h> should be included directly."
#endif
#include <glib-object.h>
G_BEGIN_DECLS
#define NAUTILUS_TYPE_COLUMN (nautilus_column_get_type())
G_DECLARE_FINAL_TYPE (NautilusColumn, nautilus_column, NAUTILUS, COLUMN, GObject)
/**
* NautilusColumn:
*
* List view column descriptor object.
*
* `NautilusColumn` is an object that describes a column in the file manager
* list view. Extensions can provide `NautilusColumn` by registering a
* [iface@ColumnProvider] and returning them from
* [method@ColumnProvider.get_columns], which will be called by the main
* application when creating a view.
*/
/**
* nautilus_column_new:
* @name: (not nullable): identifier of the column
* @attribute: (not nullable): the file attribute to be displayed in the column
* @label: (not nullable): the user-visible label for the column
* @description: (not nullable): a user-visible description of the column
*
* Creates a new [class@Column] object.
*
* Returns: (transfer full): a new #NautilusColumn
*/
NautilusColumn *nautilus_column_new (const char *name,
const char *attribute,
const char *label,
const char *description);
G_END_DECLS