Add descriptions to exported functions
authorMikael Berthe <mikael@lilotux.net>
Sat, 28 Jun 2014 20:36:10 +0200
changeset 3 d08d45871171
parent 2 55098d552ae2
child 4 bcc0975496bc
Add descriptions to exported functions
goduf-byinode_fallback.go
goduf-byinode_unix.go
--- a/goduf-byinode_fallback.go	Sat Jun 28 18:28:09 2014 +0200
+++ b/goduf-byinode_fallback.go	Sat Jun 28 20:36:10 2014 +0200
@@ -14,10 +14,13 @@
 	return true
 }
 
+// OSHasInodes returns true iff the O.S. uses inodes for its filesystems.
 func OSHasInodes() bool {
 	return false
 }
 
+// GetDevIno returns the device and inode IDs of a given file.
+// This is not supported on Windows and Plan9.
 func GetDevIno(fi os.FileInfo) (uint64, uint64) {
 	return 0, 0 // Not supported
 }
--- a/goduf-byinode_unix.go	Sat Jun 28 18:28:09 2014 +0200
+++ b/goduf-byinode_unix.go	Sat Jun 28 20:36:10 2014 +0200
@@ -26,10 +26,12 @@
 	return iInode < jInode
 }
 
+// OSHasInodes returns true iff the O.S. uses inodes for its filesystems.
 func OSHasInodes() bool {
 	return true
 }
 
+// GetDevIno returns the device and inode IDs of a given file.
 func GetDevIno(fi os.FileInfo) (uint64, uint64) {
 	dev := fi.Sys().(*syscall.Stat_t).Dev
 	ino := fi.Sys().(*syscall.Stat_t).Ino