Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lack of documentation costs hours #87

Open
jfrumar opened this issue May 9, 2016 · 0 comments
Open

Lack of documentation costs hours #87

jfrumar opened this issue May 9, 2016 · 0 comments

Comments

@jfrumar
Copy link

jfrumar commented May 9, 2016

There is no documentation for this module, both in the README and in the code (there's no comments, no function JSdoc headers, nothing).

This means we've spent countless hours trying to determine how to interface with, and grok this module. The PBX file format is tough enough on its own, so adding code on top of it makes it a very blurry-eyed experience.

It's impossible to tell which functions are designed to be called externally, and which ones are purely for internal purposes only since the whole pbxProject class is exported, and every function is exposed on the prototype. For example a internal use function prefix (like '_internalOnlyFunc()') would give a big hint, or just not putting every internal helper function on the prototype would help too.

I'm trying to modify a simple "Copy Files Phase" framework to enable code signing. The file doesn't appear in the PBXBuildFile section until I manually click the "Code Sign On Copy" in xcode. I am trying to add the file to the PBXBuildFile section so that I can specify the "CodeSignOnCopy" attribute.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant