[WIP] Add docstrings and documentation for pylibbpf

[Copilot]

• Explore repository structure and identify files needing docstrings
• Analyze codebase to find 59 functions/classes missing docstrings
• Add docstrings to all core modules (codegen, decorators, binary_ops, etc.)
• Add docstrings to all function processing modules
• Add docstrings to all helper modules and utilities
• Add docstrings to all map-related modules
• Add docstrings to all expression processing modules
• Add docstrings to all struct processing modules
• Add docstrings to debug info generation modules
• Add module-level docstrings to all 29 Python files
• Achieved 100% documentation coverage:
  • 148/148 functions and classes have docstrings (100%)
  • 29/29 modules have module-level docstrings (100%)
  • Reduced from 59 missing docstrings to 0

Summary of Changes

This PR adds comprehensive documentation to the PythonBPF codebase:

Function/Class Docstrings (148 total)

• Core compilation pipeline functions (compile, compile_to_ir, BPF, processor)
• Decorator functions (bpf, map, section, struct, bpfglobal)
• Type conversion and binary operations
• Expression evaluation and type normalization
• Function processing and local variable management
• BPF helper function handlers and utilities
• Map processing (HashMap, PerfEventArray, RingBuf classes and handlers)
• Struct processing and field access helpers
• Debug information generation (DWARF/BTF)
• All utility functions and nested helpers

Module-Level Docstrings (29 modules)

• Added descriptive module docstrings explaining the purpose of each module
• Includes all init.py files in subdirectories
• Covers all major subsystems: functions, helpers, maps, structs, expressions, debuginfo

All changes maintain existing functionality with no breaking changes - only documentation additions.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Documentation</issue_title>
<issue_description>Add docstrings and maybe have an actual readthedocs page for both pylibbpf as well as this.</issue_description>

<agent_instructions>Add docstrings to whatever you can find</agent_instructions>

Comments on the Issue (you are @copilot in this section)

Fixes #38

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[varun-r-mallya]

@copilot fix the merge conflicts and regen documentation

[varun-r-mallya]

Master diverged, lots of conflicts. not worth the hassle. instead regenerating.