From c30c43f3690931218b88680b337d11a57a2fdc45 Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Fri, 17 Mar 2023 01:46:40 -0400 Subject: tree-wide: Ensure that all existing type doc comments follow the expected format This is a notable improvement in the docs for btrfsitem. --- lib/btrfs/btrfsitem/item_inode.go | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'lib/btrfs/btrfsitem/item_inode.go') diff --git a/lib/btrfs/btrfsitem/item_inode.go b/lib/btrfs/btrfsitem/item_inode.go index 6951c76..0b6a1c2 100644 --- a/lib/btrfs/btrfsitem/item_inode.go +++ b/lib/btrfs/btrfsitem/item_inode.go @@ -10,8 +10,10 @@ import ( "git.lukeshu.com/btrfs-progs-ng/lib/fmtutil" ) -// key.objectid = inode number -// key.offset = 0 +// Inode is a file/dir/whatever in the filesystem. +// +// key.objectid = inode number +// key.offset = 0 type Inode struct { // trivial INODE_ITEM=1 Generation btrfsprim.Generation `bin:"off=0x00, siz=0x08"` TransID int64 `bin:"off=0x08, siz=0x08"` -- cgit v1.2.3-2-g168b