Cleanup: Add doxygen and restructure paint_hide.cc #119929

Merged
Hans Goudey merged 1 commits from Sean-Kim/blender:paint-hide-cleanup into main 2024-03-26 20:20:03 +01:00
Member

This PR restructures the flow of paint_hide.cc and groups the existing functions into newly added doxygen blocks.

This PR restructures the flow of `paint_hide.cc` and groups the existing functions into newly added doxygen blocks.
Sean Kim added 1 commit 2024-03-26 19:28:24 +01:00
Sean Kim requested review from Hans Goudey 2024-03-26 19:34:13 +01:00
Hans Goudey approved these changes 2024-03-26 19:42:05 +01:00
Hans Goudey left a comment
Member

I'm not sure it's that important to distinguish "Public API" from "internal visibility utilties". Whether these functions are used by other files isn't the most important way they can be organized IMO. But I can't really think of another way I like that much more, and it's very nice to have this organized at all.

I'm not sure it's that important to distinguish "Public API" from "internal visibility utilties". Whether these functions are used by other files isn't the most important way they can be organized IMO. But I can't really think of another way I like that much more, and it's very nice to have this organized at all.
Sean Kim requested review from Hans Goudey 2024-03-26 19:49:55 +01:00
Author
Member

Don't really know why it requested review a second time.

Don't really know why it requested review a second time.
Author
Member

I'm not sure it's that important to distinguish "Public API" from "internal visibility utilties". Whether these functions are used by other files isn't the most important way they can be organized IMO. But I can't really think of another way I like that much more, and it's very nice to have this organized at all.

I agree that the distinction isn't super valuable; Ideally I think the internal block would all just be private methods on a class or in a separate namespace, but I do think having the public API block may help with future maintainers knowing that the changes there are potentially more impactful.

> I'm not sure it's that important to distinguish "Public API" from "internal visibility utilties". Whether these functions are used by other files isn't the most important way they can be organized IMO. But I can't really think of another way I like that much more, and it's very nice to have this organized at all. I agree that the distinction isn't super valuable; Ideally I think the internal block would all just be private methods on a class or in a separate namespace, but I do think having the public API block may help with future maintainers knowing that the changes there are potentially more impactful.
Hans Goudey merged commit 627ec2666b into main 2024-03-26 20:20:03 +01:00
Sean Kim deleted branch paint-hide-cleanup 2024-04-05 21:27:15 +02:00
Sign in to join this conversation.
No reviewers
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset System
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Viewport & EEVEE
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Asset Browser Project
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Module
Viewport & EEVEE
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Severity
High
Severity
Low
Severity
Normal
Severity
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#119929
No description provided.