objectbox / objectbox/objectbox-swift

Documentation: Enums embedded in Class

Open
#103 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Swift
Stars
619
Forks
37
PR merge metrics
No merged PRs in 30d

Description

Suggestion to clarify documentation:

Please note:
When using Enums defined inside a Class they have to be specified on the property including the Class name

class EnumEntity: Entity {

    enum TestEnum: Int {
        case unknown = 0
        case first = 100
        case second = 200
        case third = 300
    }

    var id: Id = 0
    // objectbox: convert = { "default": ".unknown" }
    var custom: EnumEntity.TestEnum
}

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation section covering enums and the convert default syntax. Use the EnumEntity.TestEnum example from the issue to clarify the required class-qualified property type, then check nearby examples for consistent wording and formatting. Done means the documentation explicitly covers nested enums and includes a clear example.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.