blender/blender-developer-docs
7
8
Fork 38
Code Issues 3 Pull Requests 6 Activity

BLI: add high level documentation for core data structures #25

Merged
Jacques Lucke merged 14 commits from JacquesLucke/blender-developer-docs:core-data-structures into main 2024-02-19 19:09:34 +01:00
Conversation 3 Commits 14 Files Changed 13 +589
Jacques Lucke commented 2024-02-17 21:42:37 +01:00
Member
Copy Link

This adds some initial documentation for various c++ types I worked on in blenlib. The purpose is to make it easier for people to find what exists and how it is generally used. For more details, one still has to go into the corresponding header file. I added links to these header files where appropriate.

image

This adds some initial documentation for various c++ types I worked on in blenlib. The purpose is to make it easier for people to find what exists and how it is generally used. For more details, one still has to go into the corresponding header file. I added links to these header files where appropriate. ![image](/attachments/d36bf211-2423-4b6f-bce6-0d26e3c26f8b)
image.png
23 KiB
image.png
32 KiB
image.png
Jacques Lucke added 1 commit 2024-02-17 21:42:38 +01:00
Jacques Lucke added 7 commits 2024-02-18 15:02:15 +01:00
Jacques Lucke added 2 commits 2024-02-18 18:34:48 +01:00
Jacques Lucke added 2 commits 2024-02-18 19:25:50 +01:00
Jacques Lucke changed title from WIP: BLI: add high level documentation for core data structures to BLI: add high level documentation for core data structures 2024-02-18 19:26:31 +01:00
Jacques Lucke requested review from Julian Eisel 2024-02-18 19:31:16 +01:00
Jacques Lucke requested review from Hans Goudey 2024-02-18 19:31:16 +01:00
Julian Eisel commented 2024-02-19 12:31:01 +01:00
Member
Copy Link

Nice! I'd strongly suggest mentioning "BLI" in the hierarchy, otherwise it's not clear what this refers to. Might as well be DNA or BKE data structures. So something like "Core" > "BLI: Blender Library"

Nice! I'd strongly suggest mentioning "BLI" in the hierarchy, otherwise it's not clear what this refers to. Might as well be DNA or BKE data structures. So something like "_Core_" > "_BLI: Blender Library_"
Jacques Lucke added 1 commit 2024-02-19 12:46:17 +01:00
Jacques Lucke commented 2024-02-19 12:47:08 +01:00
Author
Member
Copy Link

Ok, I changed the navigation and updated the screenshot.

Ok, I changed the navigation and updated the screenshot.
Hans Goudey added 1 commit 2024-02-19 18:09:00 +01:00
Hans Goudey approved these changes 2024-02-19 18:13:29 +01:00
Hans Goudey left a comment
Member
Copy Link

Looks good, this will be really helpful.

  • Lines should be wrapped to 100 characters I guess
  • A page on "generic data structures" would be nice: GSpan, GArray, GVArray, etc. But that could be added later
Looks good, this will be really helpful. - Lines should be wrapped to 100 characters I guess - A page on "generic data structures" would be nice: `GSpan`, `GArray`, `GVArray`, etc. But that could be added later
Jacques Lucke commented 2024-02-19 19:08:36 +01:00
Author
Member
Copy Link

Lines should be wrapped to 100 characters I guess

Won't do that now, as discussed in chat.

A page on "generic data structures" would be nice: GSpan, GArray, GVArray, etc. But that could be added later

Yeah, had to stop somewhere.

> Lines should be wrapped to 100 characters I guess Won't do that now, as discussed in chat. > A page on "generic data structures" would be nice: GSpan, GArray, GVArray, etc. But that could be added later Yeah, had to stop somewhere.
Jacques Lucke merged commit 537ace064c into main 2024-02-19 19:09:34 +01:00
Jacques Lucke deleted branch core-data-structures 2024-02-19 19:09:35 +01:00
Sign in to join this conversation.
Reviewers
No reviewers
Julian Eisel
Hans Goudey
Labels
Clear labels
No items
No Label
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
3 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-developer-docs#25
No description provided.
Delete Branch "JacquesLucke/blender-developer-docs:core-data-structures"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?