addFolder

Add member folder to package

Since R2024b

collapse all in page

    Syntax

    addFolder(pkg,folders)
    addFolder(pkg,folders,Languages=lang)

    Description

    addFolder(pkg,folders) adds the specified folders as member folders to the package and updates the Folders property of the package object. The package pkg must be in editable mode.

    example

    addFolder(pkg,folders,Languages=lang) specifies the language of the added folder.

    example

    Examples

    collapse all

    Create a package named MyPackage.

    pkg = mpmcreate("MyPackage","MyPackage");

    Add a new member folder to MyPackage. 

    mkdir("MyPackage/Classes")
pkg.Folders
    ans = 

  1×0 PackageFolder array with properties:

    Path
    Languages

    Update the package to include the new member folder by using addFolder.

    addFolder(pkg,"Classes")
pkg.Folders
    ans = 

  PackageFolder with properties:

       Path: "Classes"
  Languages: matlab

    Create a package named MyPackage.

    pkg = mpmcreate("MyPackage","MyPackage");

    Add a new member folder to MyPackage. 

    mkdir("MyPackage/Classes")
pkg.Folders
    ans = 

  1×0 PackageFolder array with properties:

    Path
    Languages

    Update the package to include the new member folder by using addFolder.

    addFolder(pkg,"Classes",Langauges="java")
pkg.Folders
    ans = 

  PackageFolder with properties:

       Path: "Classes"
  Languages: java

    Input Arguments

    collapse all

    Package, specified as a matlab.mpm.Package object.

    Member folders to add, specified as a string array where each element is the path to a folder, or a matlab.mpm.PackageFolder array. All elements of folders must represent folders that exist.

    Folder Language, specified as a string array with values of "matlab" or "java". A folder can be designated as one or more languages. Folders designated as matlab are automatically added to the MATLAB search path when the package is installed. Folders designated as java are added to the Java class path, allowing Java resources to be accessible within MATLAB. If a package folder is not designated as matlab, MATLAB files in that folder are ignored. If a package folder is not designated as java, JAR files in that folder are ignored.

    This argument sets the Languages property of the folder.

    Version History

    Introduced in R2024b

    See Also

    Objects

    Functions

    Topics