appledoc icon indicating copy to clipboard operation
appledoc copied to clipboard

Unable to Set Copyright Information

Open dpfannenstiel opened this issue 7 years ago • 1 comments

I'm attempting to set copyright information on my documentation. The --docset-copyright flag does not seem to be having an effect.

appledoc --project-name "Sample" --project-company "NOT_COPYRIGHT" --keep-intermediate-files --output "~/Desktop/ad" --docset-copyright "TOTALLY_YES_COPYRIGHT" --print-settings  .
appledoc version: 2.2.1 (build 1333)

WARN: --company-id argument or global setting not given, but creating DocSet is enabled, will use 'com.not_copyright.sample'!
Running for files in locations:
- .

Settings used for this run:
--project-name = Sample
--project-version = 1.0
--project-company = NOT_COPYRIGHT
--company-id = com.not_copyright.sample

--templates = ~/.appledoc
--output = ~/Desktop/ad
--index-desc = (null)
--docset-install-path = /Users/dustin/Library/Developer/Shared/Documentation/DocSets
--xcrun-path = /usr/bin/xcrun

--docset-bundle-id = com.not_copyright.sample.Sample
--docset-bundle-name = Sample Documentation
--docset-desc = 
--docset-copyright = TOTALLY_YES_COPYRIGHT
--docset-feed-name = Sample Documentation
--docset-feed-url = 
--docset-feed-formats = atom
--docset-package-url = 
--docset-fallback-url = 
--docset-publisher-id = com.not_copyright.sample.documentation
--docset-publisher-name = NOT_COPYRIGHT
--docset-min-xcode-version = 3.0
--docset-platform-family = 
--docset-cert-issuer = 
--docset-cert-signer = 
--docset-bundle-filename = com.not_copyright.sample.Sample.docset
--docset-atom-filename = com.not_copyright.sample.Sample.atom
--docset-xml-filename = com.not_copyright.sample.Sample.xml
--docset-package-filename = com.not_copyright.sample.Sample-1.0

--clean-output = NO
--create-html = YES
--create-docset = YES
--install-docset = YES
--publish-docset = NO
--html-anchors = appledoc
--keep-intermediate-files = YES
--keep-undocumented-objects = NO
--keep-undocumented-members = NO
--search-undocumented-doc = YES
--repeat-first-par = YES
--preprocess-headerdoc = NO
--print-information-block-titles = YES
--use-single-star = NO
--merge-categories = YES
--merge-category-comment = YES
--keep-merged-sections = NO
--prefix-merged-sections = NO
--crossref-format = <?%@>?
--use-code-order = (null)
--exit-threshold = 0

--warn-missing-output-path = YES
--warn-missing-company-id = YES
--warn-undocumented-object = YES
--warn-undocumented-member = YES
--warn-empty-description = YES
--warn-unknown-directive = YES
--warn-invalid-crossref = YES
--warn-missing-arg = YES

--logformat = 1
--verbose = 2

The desired output in the copyright (for this very weak example) would be: screen shot 2017-02-21 at 2 52 36 pm

In reality it is: screen shot 2017-02-21 at 2 48 49 pm

I am expecting the literal string to be added in the copyright place (not just have a company name be included in a format string).

dpfannenstiel avatar Feb 21 '17 20:02 dpfannenstiel

I see, the template is probably wired to use company name. For the moment you can either change template or use --project-company

tomaz avatar Feb 22 '17 07:02 tomaz