Improve documentation for FD types

Author: Jacalz

openuri/opendir.go

@@ -16,6 +16,7 @@ type OpenDirOptions struct {
 }
 
 // OpenDirectory asks to open the directory containing a local file in the file browser.
+// The input parameter fd should be a file descriptor like the one given from [*os.File.Fd] for example.
 func OpenDirectory(parentWindow string, fd uintptr, options *OpenDirOptions) error {
 	conn, err := dbus.SessionBus() // Shared connection, don't close.
 	if err != nil {

openuri/openfile.go

@@ -16,6 +16,7 @@ type OpenFileOptions struct {
 }
 
 // OpenFile asks to open a local file.
+// The input parameter fd should be a file descriptor like the one given from [*os.File.Fd] for example.
 func OpenFile(parentWindow string, fd uintptr, options *OpenFileOptions) error {
 	conn, err := dbus.SessionBus() // Shared connection, don't close.
 	if err != nil {

openuri/openuri.go

@@ -21,6 +21,8 @@ type OpenURIOptions struct {
 }
 
 // OpenURI opens the given URI in the corresponding application.
+// Note that file:// URIs are explicitly not supported by this method.
+// To request opening local files, use [OpenFile].
 func OpenURI(parentWindow, uri string, options *OpenURIOptions) error {
 	conn, err := dbus.SessionBus() // Shared connection, don't close.
 	if err != nil {

trash/trashfile.go

@@ -17,6 +17,7 @@ const (
 )
 
 // TrashFile sends a file to the trashcan. Applications are allowed to trash a file if they can open it in r/w mode.
+// The input parameter fd should be a file descriptor like the one given from [*os.File.Fd] for example.
 func TrashFile(fd uintptr) (TrashResult, error) {
 	conn, err := dbus.SessionBus() // Shared connection, don't close.
 	if err != nil {